libctru/gdbhio__dev_8h_source.html
2024-11-03 20:36:34 +00:00

125 lines
13 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libctru: include/3ds/gdbhio_dev.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>
<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">libctru
&#160;<span id="projectnumber">v2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">gdbhio_dev.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="gdbhio__dev_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * @file gdbhio_dev.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * @brief Luma3DS GDB HIO (called File I/O in GDB documentation) devoptab wrapper.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">struct </span>timeval;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">///&lt; Initializes the GDB HIO devoptab wrapper, returns 0 on success, -1 on failure.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#ab44de89874574244f5f24a222e1d41ba"> 13</a></span>&#160;<span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="gdbhio__dev_8h.html#ab44de89874574244f5f24a222e1d41ba">gdbHioDevInit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">///&lt; Deinitializes the GDB HIO devoptab wrapper.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#a623fa8310ed3c02993ef7255119b3c7e"> 16</a></span>&#160;<span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="gdbhio__dev_8h.html#a623fa8310ed3c02993ef7255119b3c7e">gdbHioDevExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">///&lt; Returns a file descriptor mapping to the GDB client console&#39;s standard input stream.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#ab94098ccdaf205f64aa8e44c82f54e36"> 19</a></span>&#160;<span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="gdbhio__dev_8h.html#ab94098ccdaf205f64aa8e44c82f54e36">gdbHioDevGetStdin</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">///&lt; Returns a file descriptor mapping to the GDB client console&#39;s standard output stream.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#aa08aeffcc4fa68a69fb98e7d3d4c1f8f"> 22</a></span>&#160;<span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="gdbhio__dev_8h.html#aa08aeffcc4fa68a69fb98e7d3d4c1f8f">gdbHioDevGetStdout</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">///&lt; Returns a file descriptor mapping to the GDB client console&#39;s standard error stream.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#a0f52252119bf703d15d8a12765196671"> 25</a></span>&#160;<span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="gdbhio__dev_8h.html#a0f52252119bf703d15d8a12765196671">gdbHioDevGetStderr</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">///&lt; Redirects 0 to 3 of the application&#39;s standard streams to GDB client console&#39;s. Returns -1, -2, or -3, resp., on failure; 0 on success.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#aca64636a4fbe34902d57268363cb29ac"> 28</a></span>&#160;<span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="gdbhio__dev_8h.html#aca64636a4fbe34902d57268363cb29ac">gdbHioDevRedirectStdStreams</a>(<span class="keywordtype">bool</span> in, <span class="keywordtype">bool</span> out, <span class="keywordtype">bool</span> err);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">///&lt; GDB HIO POSIX function gettimeofday.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#a39b9ea0f30767f0d434eda5d0f605445"> 31</a></span>&#160;<span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="gdbhio__dev_8h.html#a39b9ea0f30767f0d434eda5d0f605445">gdbHioDevGettimeofday</a>(<span class="keyword">struct</span> timeval *tv, <span class="keywordtype">void</span> *tz);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">///&lt; GDB HIO POSIX function isatty.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="gdbhio__dev_8h.html#aa97cf5954c6fde94c63f6594de0e4051"> 34</a></span>&#160;<span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="gdbhio__dev_8h.html#aa97cf5954c6fde94c63f6594de0e4051">gdbHioDevIsatty</a>(<span class="keywordtype">int</span> fd);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">///&lt; GDB HIO POSIX function system. Requires &#39;set remote system-call-allowed 1&#39;.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"></span><span class="keywordtype">int</span> gdbHioDevSystem(<span class="keyword">const</span> <span class="keywordtype">char</span> *command);</div>
<div class="ttc" id="agdbhio__dev_8h_html_a0f52252119bf703d15d8a12765196671"><div class="ttname"><a href="gdbhio__dev_8h.html#a0f52252119bf703d15d8a12765196671">gdbHioDevGetStderr</a></div><div class="ttdeci">int gdbHioDevGetStderr(void)</div><div class="ttdoc">Redirects 0 to 3 of the application's standard streams to GDB client console's. Returns -1,...</div></div>
<div class="ttc" id="agdbhio__dev_8h_html_a39b9ea0f30767f0d434eda5d0f605445"><div class="ttname"><a href="gdbhio__dev_8h.html#a39b9ea0f30767f0d434eda5d0f605445">gdbHioDevGettimeofday</a></div><div class="ttdeci">int gdbHioDevGettimeofday(struct timeval *tv, void *tz)</div><div class="ttdoc">GDB HIO POSIX function isatty.</div></div>
<div class="ttc" id="agdbhio__dev_8h_html_a623fa8310ed3c02993ef7255119b3c7e"><div class="ttname"><a href="gdbhio__dev_8h.html#a623fa8310ed3c02993ef7255119b3c7e">gdbHioDevExit</a></div><div class="ttdeci">void gdbHioDevExit(void)</div><div class="ttdoc">Returns a file descriptor mapping to the GDB client console's standard input stream.</div></div>
<div class="ttc" id="agdbhio__dev_8h_html_aa08aeffcc4fa68a69fb98e7d3d4c1f8f"><div class="ttname"><a href="gdbhio__dev_8h.html#aa08aeffcc4fa68a69fb98e7d3d4c1f8f">gdbHioDevGetStdout</a></div><div class="ttdeci">int gdbHioDevGetStdout(void)</div><div class="ttdoc">Returns a file descriptor mapping to the GDB client console's standard error stream.</div></div>
<div class="ttc" id="agdbhio__dev_8h_html_aa97cf5954c6fde94c63f6594de0e4051"><div class="ttname"><a href="gdbhio__dev_8h.html#aa97cf5954c6fde94c63f6594de0e4051">gdbHioDevIsatty</a></div><div class="ttdeci">int gdbHioDevIsatty(int fd)</div><div class="ttdoc">GDB HIO POSIX function system. Requires 'set remote system-call-allowed 1'.</div></div>
<div class="ttc" id="agdbhio__dev_8h_html_ab44de89874574244f5f24a222e1d41ba"><div class="ttname"><a href="gdbhio__dev_8h.html#ab44de89874574244f5f24a222e1d41ba">gdbHioDevInit</a></div><div class="ttdeci">int gdbHioDevInit(void)</div><div class="ttdoc">Initializes the GDB HIO devoptab wrapper, returns 0 on success, -1 on failure.</div></div>
<div class="ttc" id="agdbhio__dev_8h_html_ab94098ccdaf205f64aa8e44c82f54e36"><div class="ttname"><a href="gdbhio__dev_8h.html#ab94098ccdaf205f64aa8e44c82f54e36">gdbHioDevGetStdin</a></div><div class="ttdeci">int gdbHioDevGetStdin(void)</div><div class="ttdoc">Returns a file descriptor mapping to the GDB client console's standard output stream.</div></div>
<div class="ttc" id="agdbhio__dev_8h_html_aca64636a4fbe34902d57268363cb29ac"><div class="ttname"><a href="gdbhio__dev_8h.html#aca64636a4fbe34902d57268363cb29ac">gdbHioDevRedirectStdStreams</a></div><div class="ttdeci">int gdbHioDevRedirectStdStreams(bool in, bool out, bool err)</div><div class="ttdoc">GDB HIO POSIX function gettimeofday.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>