155 lines
16 KiB
HTML
155 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">
|
|
<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>uvw: src/uvw/tty.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">uvw
|
|
 <span id="projectnumber">2.12.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&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&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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_98934c98f70735fe3a272005a9eb8736.html">uvw</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">tty.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef UVW_TTY_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define UVW_TTY_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "stream.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "util.h"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">namespace </span>details {</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">struct </span>ResetModeMemo {</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  ~ResetModeMemo();</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> };</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">enum class</span> UVTTYModeT : std::underlying_type_t<uv_tty_mode_t> {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  NORMAL = UV_TTY_MODE_NORMAL,</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  RAW = UV_TTY_MODE_RAW,</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  IO = UV_TTY_MODE_IO</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> };</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">enum class</span> UVTTYVTermStateT : std::underlying_type_t<uv_tty_vtermstate_t> {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  SUPPORTED = UV_TTY_SUPPORTED,</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  UNSUPPORTED = UV_TTY_UNSUPPORTED</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> };</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> } <span class="comment">// namespace details</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classuvw_1_1TTYHandle.html"> 49</a></span> <span class="keyword">class </span><a class="code" href="classuvw_1_1TTYHandle.html">TTYHandle</a> final: <span class="keyword">public</span> <a class="code" href="classuvw_1_1StreamHandle.html">StreamHandle</a><TTYHandle, uv_tty_t> {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">static</span> std::shared_ptr<details::ResetModeMemo> resetModeMemo();</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">using</span> Mode = details::UVTTYModeT;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">using</span> VTermState = details::UVTTYVTermStateT;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">explicit</span> <a class="code" href="classuvw_1_1TTYHandle.html">TTYHandle</a>(ConstructorAccess ca, std::shared_ptr<Loop> ref, <a class="code" href="namespaceuvw.html#a02b7ef3b5a65b0bec1602ef434806a27">FileHandle</a> desc, <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1StreamHandle.html#a91efe7dfb93505779edbf603a6a1c515">readable</a>);</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classuvw_1_1TTYHandle.html#acefb0c1bc2b6c953788b597b12fc0993"> 62</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1TTYHandle.html#acefb0c1bc2b6c953788b597b12fc0993">init</a>();</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classuvw_1_1TTYHandle.html#a586423b15b4659aeb772b4b308a01e97"> 80</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1TTYHandle.html#a586423b15b4659aeb772b4b308a01e97">mode</a>(Mode m);</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classuvw_1_1TTYHandle.html#af1aad21eb7c7b71c94c622e9c5f45df2"> 86</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1TTYHandle.html#af1aad21eb7c7b71c94c622e9c5f45df2">reset</a>() noexcept;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classuvw_1_1TTYHandle.html#a95fcfce3a8acc4ae1a3453b367c4adec"> 92</a></span>  <a class="code" href="structuvw_1_1WinSize.html">WinSize</a> <a class="code" href="classuvw_1_1TTYHandle.html#a95fcfce3a8acc4ae1a3453b367c4adec">getWinSize</a>();</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classuvw_1_1TTYHandle.html#a0a0d098ba1b88116e3679fd49a76f14f"> 112</a></span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1TTYHandle.html#a02f304c96cc8858a489846d500a56df3">vtermState</a>(VTermState s) const noexcept;</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classuvw_1_1TTYHandle.html#a02f304c96cc8858a489846d500a56df3"> 131</a></span>  VTermState <a class="code" href="classuvw_1_1TTYHandle.html#a02f304c96cc8858a489846d500a56df3">vtermState</a>() const noexcept;</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> private:</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  std::shared_ptr<details::ResetModeMemo> memo;</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="namespaceuvw.html#a02b7ef3b5a65b0bec1602ef434806a27">FileHandle</a>::Type fd;</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">int</span> rw;</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> };</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> } <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  </div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor"># include "tty.cpp"</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif </span><span class="comment">// UVW_TTY_INCLUDE_H</span></div>
|
|
<div class="ttc" id="aclassuvw_1_1StreamHandle_html"><div class="ttname"><a href="classuvw_1_1StreamHandle.html">uvw::StreamHandle</a></div><div class="ttdoc">The StreamHandle handle.</div><div class="ttdef"><b>Definition:</b> <a href="stream_8h_source.html#l00113">stream.h:113</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1StreamHandle_html_a91efe7dfb93505779edbf603a6a1c515"><div class="ttname"><a href="classuvw_1_1StreamHandle.html#a91efe7dfb93505779edbf603a6a1c515">uvw::StreamHandle< TTYHandle, uv_tty_t >::readable</a></div><div class="ttdeci">bool readable() const noexcept</div><div class="ttdoc">Checks if the stream is readable.</div><div class="ttdef"><b>Definition:</b> <a href="stream_8h_source.html#l00436">stream.h:436</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TTYHandle_html"><div class="ttname"><a href="classuvw_1_1TTYHandle.html">uvw::TTYHandle</a></div><div class="ttdoc">The TTYHandle handle.</div><div class="ttdef"><b>Definition:</b> <a href="tty_8h_source.html#l00049">tty.h:49</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TTYHandle_html_a02f304c96cc8858a489846d500a56df3"><div class="ttname"><a href="classuvw_1_1TTYHandle.html#a02f304c96cc8858a489846d500a56df3">uvw::TTYHandle::vtermState</a></div><div class="ttdeci">VTermState vtermState() const noexcept</div><div class="ttdoc">Gets the current state of whether console virtual terminal sequences are handled by the library or th...</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TTYHandle_html_a586423b15b4659aeb772b4b308a01e97"><div class="ttname"><a href="classuvw_1_1TTYHandle.html#a586423b15b4659aeb772b4b308a01e97">uvw::TTYHandle::mode</a></div><div class="ttdeci">bool mode(Mode m)</div><div class="ttdoc">Sets the TTY using the specified terminal mode.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TTYHandle_html_a95fcfce3a8acc4ae1a3453b367c4adec"><div class="ttname"><a href="classuvw_1_1TTYHandle.html#a95fcfce3a8acc4ae1a3453b367c4adec">uvw::TTYHandle::getWinSize</a></div><div class="ttdeci">WinSize getWinSize()</div><div class="ttdoc">Gets the current Window size.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TTYHandle_html_acefb0c1bc2b6c953788b597b12fc0993"><div class="ttname"><a href="classuvw_1_1TTYHandle.html#acefb0c1bc2b6c953788b597b12fc0993">uvw::TTYHandle::init</a></div><div class="ttdeci">bool init()</div><div class="ttdoc">Initializes the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TTYHandle_html_af1aad21eb7c7b71c94c622e9c5f45df2"><div class="ttname"><a href="classuvw_1_1TTYHandle.html#af1aad21eb7c7b71c94c622e9c5f45df2">uvw::TTYHandle::reset</a></div><div class="ttdeci">bool reset() noexcept</div><div class="ttdoc">Resets TTY settings to default values.</div></div>
|
|
<div class="ttc" id="anamespaceuvw_html"><div class="ttname"><a href="namespaceuvw.html">uvw</a></div><div class="ttdoc">uvw default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="async_8h_source.html#l00008">async.h:8</a></div></div>
|
|
<div class="ttc" id="anamespaceuvw_html_a02b7ef3b5a65b0bec1602ef434806a27"><div class="ttname"><a href="namespaceuvw.html#a02b7ef3b5a65b0bec1602ef434806a27">uvw::FileHandle</a></div><div class="ttdeci">details::UVTypeWrapper< uv_file > FileHandle</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00204">util.h:204</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1WinSize_html"><div class="ttname"><a href="structuvw_1_1WinSize.html">uvw::WinSize</a></div><div class="ttdoc">Windows size representation.</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00196">util.h:196</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|