162 lines
17 KiB
HTML
162 lines
17 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.9.6"/>
|
|
<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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<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" 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');
|
|
$(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">
|
|
<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 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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef UVW_TTY_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_TTY_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "config.h"</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "stream.h"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "util.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span>details {</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">struct </span>reset_mode_memo {</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> ~reset_mode_memo();</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>};</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><span class="keyword">enum class</span> uvw_tty_mode_t : std::underlying_type_t<uv_tty_mode_t> {</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> NORMAL = UV_TTY_MODE_NORMAL,</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> RAW = UV_TTY_MODE_RAW,</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> IO = UV_TTY_MODE_IO</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>};</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">enum class</span> uvw_tty_vtermstate_t : std::underlying_type_t<uv_tty_vtermstate_t> {</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> SUPPORTED = UV_TTY_SUPPORTED,</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> UNSUPPORTED = UV_TTY_UNSUPPORTED</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>};</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>} <span class="comment">// namespace details</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classuvw_1_1tty__handle.html"> 50</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1tty__handle.html">tty_handle</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1stream__handle.html">stream_handle</a><tty_handle, uv_tty_t> {</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> std::shared_ptr<details::reset_mode_memo> mode_memo_handler();</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">using </span>tty_mode = details::uvw_tty_mode_t;</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">using </span>tty_vtermstate = details::uvw_tty_vtermstate_t;</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classuvw_1_1tty__handle.html">tty_handle</a>(loop::token token, std::shared_ptr<loop> ref, <a class="code hl_typedef" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> desc, <span class="keywordtype">bool</span> <a class="code hl_function" href="classuvw_1_1stream__handle.html#a459eccecaee81d4a8619e1a073e81a69">readable</a>);</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classuvw_1_1tty__handle.html#aa9307635764951c0d8633e0b735dc2ee"> 63</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1tty__handle.html#aa9307635764951c0d8633e0b735dc2ee">init</a>() final;</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classuvw_1_1tty__handle.html#a49af3a13ee30f7b02ec0d4a15a9361b9"> 81</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classuvw_1_1tty__handle.html#a49af3a13ee30f7b02ec0d4a15a9361b9">mode</a>(tty_mode m);</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classuvw_1_1tty__handle.html#aca9a056acdf70d1e8fba7f3ab5351ff1"> 87</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classuvw_1_1tty__handle.html#aca9a056acdf70d1e8fba7f3ab5351ff1">reset_mode</a>() noexcept;</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classuvw_1_1tty__handle.html#a9f9a002b2802f162f1afff50b9f1306d"> 93</a></span> <a class="code hl_struct" href="structuvw_1_1win__size.html">win_size</a> <a class="code hl_function" href="classuvw_1_1tty__handle.html#a9f9a002b2802f162f1afff50b9f1306d">get_win_size</a>();</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classuvw_1_1tty__handle.html#a7bac42546f774bf99513537eea0fcd60"> 113</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classuvw_1_1tty__handle.html#a3e8a2190f47b463ecfc3df7a3da46f23">vterm_state</a>(tty_vtermstate s) const noexcept;</div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="classuvw_1_1tty__handle.html#a3e8a2190f47b463ecfc3df7a3da46f23"> 132</a></span> tty_vtermstate <a class="code hl_function" href="classuvw_1_1tty__handle.html#a3e8a2190f47b463ecfc3df7a3da46f23">vterm_state</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> </div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>private:</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> std::shared_ptr<details::reset_mode_memo> memo;</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <a class="code hl_typedef" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> fd;</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">int</span> rw;</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>};</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span>} <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="preprocessor"># include "tty.cpp"</span></div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="preprocessor">#endif </span><span class="comment">// UVW_TTY_INCLUDE_H</span></div>
|
|
<div class="ttc" id="aclassuvw_1_1stream__handle_html"><div class="ttname"><a href="classuvw_1_1stream__handle.html">uvw::stream_handle</a></div><div class="ttdoc">The stream handle.</div><div class="ttdef"><b>Definition:</b> <a href="stream_8h_source.html#l00108">stream.h:108</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1stream__handle_html_a459eccecaee81d4a8619e1a073e81a69"><div class="ttname"><a href="classuvw_1_1stream__handle.html#a459eccecaee81d4a8619e1a073e81a69">uvw::stream_handle< tty_handle, 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#l00424">stream.h:424</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1tty__handle_html"><div class="ttname"><a href="classuvw_1_1tty__handle.html">uvw::tty_handle</a></div><div class="ttdoc">The tty handle.</div><div class="ttdef"><b>Definition:</b> <a href="tty_8h_source.html#l00050">tty.h:50</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1tty__handle_html_a3e8a2190f47b463ecfc3df7a3da46f23"><div class="ttname"><a href="classuvw_1_1tty__handle.html#a3e8a2190f47b463ecfc3df7a3da46f23">uvw::tty_handle::vterm_state</a></div><div class="ttdeci">tty_vtermstate vterm_state() 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_1tty__handle_html_a49af3a13ee30f7b02ec0d4a15a9361b9"><div class="ttname"><a href="classuvw_1_1tty__handle.html#a49af3a13ee30f7b02ec0d4a15a9361b9">uvw::tty_handle::mode</a></div><div class="ttdeci">bool mode(tty_mode m)</div><div class="ttdoc">Sets the TTY using the specified terminal mode.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1tty__handle_html_a9f9a002b2802f162f1afff50b9f1306d"><div class="ttname"><a href="classuvw_1_1tty__handle.html#a9f9a002b2802f162f1afff50b9f1306d">uvw::tty_handle::get_win_size</a></div><div class="ttdeci">win_size get_win_size()</div><div class="ttdoc">Gets the current Window size.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1tty__handle_html_aa9307635764951c0d8633e0b735dc2ee"><div class="ttname"><a href="classuvw_1_1tty__handle.html#aa9307635764951c0d8633e0b735dc2ee">uvw::tty_handle::init</a></div><div class="ttdeci">int init() final</div><div class="ttdoc">Initializes the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1tty__handle_html_aca9a056acdf70d1e8fba7f3ab5351ff1"><div class="ttname"><a href="classuvw_1_1tty__handle.html#aca9a056acdf70d1e8fba7f3ab5351ff1">uvw::tty_handle::reset_mode</a></div><div class="ttdeci">bool reset_mode() 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_a28622e02bfff09ba6cf8a86a929917ee"><div class="ttname"><a href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">uvw::file_handle</a></div><div class="ttdeci">details::uv_type_wrapper< uv_file > file_handle</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00085">util.h:85</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1win__size_html"><div class="ttname"><a href="structuvw_1_1win__size.html">uvw::win_size</a></div><div class="ttdoc">Windows size representation.</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00078">util.h:78</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.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|