jns
/
pubnix
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
pubnix/lib/neovision/doc/html/df/dd1/classneovision_1_1_i_o.html

369 lines
19 KiB
HTML
Raw Blame History

<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NeoVision: neovision::IO Class 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>
<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">NeoVision
</div>
<div id="projectbrief">A &quot;modern&quot; take on the turbovision tui library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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="../../d6/d46/namespaceneovision.html">neovision</a></li><li class="navelem"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html">IO</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="../../d8/d89/classneovision_1_1_i_o-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">neovision::IO Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Input/Output.
<a href="../../df/dd1/classneovision_1_1_i_o.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d3/da1/crt_8h_source.html">crt.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3c8b3d741c425ec03383cc85177a483d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#a3c8b3d741c425ec03383cc85177a483d">IO</a> ()</td></tr>
<tr class="memdesc:a3c8b3d741c425ec03383cc85177a483d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="../../df/dd1/classneovision_1_1_i_o.html#a3c8b3d741c425ec03383cc85177a483d">More...</a><br /></td></tr>
<tr class="separator:a3c8b3d741c425ec03383cc85177a483d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff7c67892ab6fbb01a441e093d80c2fa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#aff7c67892ab6fbb01a441e093d80c2fa">IO</a> (<a class="el" href="../../df/dd1/classneovision_1_1_i_o.html">IO</a> const &amp;)=delete</td></tr>
<tr class="memdesc:aff7c67892ab6fbb01a441e093d80c2fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor (deleted). <a href="../../df/dd1/classneovision_1_1_i_o.html#aff7c67892ab6fbb01a441e093d80c2fa">More...</a><br /></td></tr>
<tr class="separator:aff7c67892ab6fbb01a441e093d80c2fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada91295a45372b7c033e1eeb83f6cf3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#ada91295a45372b7c033e1eeb83f6cf3c">operator=</a> (<a class="el" href="../../df/dd1/classneovision_1_1_i_o.html">IO</a> const &amp;)=delete</td></tr>
<tr class="memdesc:ada91295a45372b7c033e1eeb83f6cf3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator (deleted). <a href="../../df/dd1/classneovision_1_1_i_o.html#ada91295a45372b7c033e1eeb83f6cf3c">More...</a><br /></td></tr>
<tr class="separator:ada91295a45372b7c033e1eeb83f6cf3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a564dbe18e9c8dbf6c36c545dffdbbc6a"><td class="memItemLeft" align="right" valign="top">std::reference_wrapper&lt; std::istream &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#a564dbe18e9c8dbf6c36c545dffdbbc6a">InputStream</a> ()</td></tr>
<tr class="memdesc:a564dbe18e9c8dbf6c36c545dffdbbc6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get input stream. <a href="../../df/dd1/classneovision_1_1_i_o.html#a564dbe18e9c8dbf6c36c545dffdbbc6a">More...</a><br /></td></tr>
<tr class="separator:a564dbe18e9c8dbf6c36c545dffdbbc6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac35d7ce7dffc8a039ed2649604f947e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#ac35d7ce7dffc8a039ed2649604f947e8">SetInputStream</a> (std::istream &amp;stream)</td></tr>
<tr class="memdesc:ac35d7ce7dffc8a039ed2649604f947e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the current input stream. <a href="../../df/dd1/classneovision_1_1_i_o.html#ac35d7ce7dffc8a039ed2649604f947e8">More...</a><br /></td></tr>
<tr class="separator:ac35d7ce7dffc8a039ed2649604f947e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af521c1e562851794e2241cb31b1a02ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#af521c1e562851794e2241cb31b1a02ee">SetOutputStream</a> (std::ostream &amp;stream)</td></tr>
<tr class="memdesc:af521c1e562851794e2241cb31b1a02ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the current output stream. <a href="../../df/dd1/classneovision_1_1_i_o.html#af521c1e562851794e2241cb31b1a02ee">More...</a><br /></td></tr>
<tr class="separator:af521c1e562851794e2241cb31b1a02ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb4dc673ec628d7c25e94e7ea45cc624"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#afb4dc673ec628d7c25e94e7ea45cc624">Write</a> (const std::string &amp;str)</td></tr>
<tr class="memdesc:afb4dc673ec628d7c25e94e7ea45cc624"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write output. <a href="../../df/dd1/classneovision_1_1_i_o.html#afb4dc673ec628d7c25e94e7ea45cc624">More...</a><br /></td></tr>
<tr class="separator:afb4dc673ec628d7c25e94e7ea45cc624"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a716f3ad3582500077fdca92cb6c32e6b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../df/dd1/classneovision_1_1_i_o.html">IO</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html#a716f3ad3582500077fdca92cb6c32e6b">Get</a> ()</td></tr>
<tr class="memdesc:a716f3ad3582500077fdca92cb6c32e6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get singleton instance. <a href="../../df/dd1/classneovision_1_1_i_o.html#a716f3ad3582500077fdca92cb6c32e6b">More...</a><br /></td></tr>
<tr class="separator:a716f3ad3582500077fdca92cb6c32e6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Input/Output. </p>
<p>Internal singleton class to hold parameters and functions for thread-safe text input and output.</p>
<p>You typically shouldn't have to interact with this unless you want to change the output (or input) stream. For instance, if you were to want to output to stderr, you could do the following:</p>
<div class="fragment"><div class="line">IO::get().SetOutputStream(std::cerr);</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="../../d3/da1/crt_8h_source.html#l00141">141</a> of file <a class="el" href="../../d3/da1/crt_8h_source.html">crt.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3c8b3d741c425ec03383cc85177a483d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c8b3d741c425ec03383cc85177a483d">&#9670;&nbsp;</a></span>IO() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">neovision::IO::IO </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p class="definition">Definition at line <a class="el" href="../../d0/da4/crt_8cpp_source.html#l00058">58</a> of file <a class="el" href="../../d0/da4/crt_8cpp_source.html">crt.cpp</a>.</p>
</div>
</div>
<a id="aff7c67892ab6fbb01a441e093d80c2fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff7c67892ab6fbb01a441e093d80c2fa">&#9670;&nbsp;</a></span>IO() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">neovision::IO::IO </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html">IO</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor (deleted). </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a716f3ad3582500077fdca92cb6c32e6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a716f3ad3582500077fdca92cb6c32e6b">&#9670;&nbsp;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html">IO</a> &amp; neovision::IO::Get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get singleton instance. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an instance of OutputParameters. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/da4/crt_8cpp_source.html#l00062">62</a> of file <a class="el" href="../../d0/da4/crt_8cpp_source.html">crt.cpp</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../df/dd1/classneovision_1_1_i_o_a716f3ad3582500077fdca92cb6c32e6b_icgraph.png" border="0" usemap="#df/dd1/classneovision_1_1_i_o_a716f3ad3582500077fdca92cb6c32e6b_icgraph" alt=""/></div>
<map name="df/dd1/classneovision_1_1_i_o_a716f3ad3582500077fdca92cb6c32e6b_icgraph" id="df/dd1/classneovision_1_1_i_o_a716f3ad3582500077fdca92cb6c32e6b_icgraph">
<area shape="rect" title="Get singleton instance." alt="" coords="211,5,339,32"/>
<area shape="rect" href="../../d6/d46/namespaceneovision.html#a883665c96887ba19dc743ec8350cadcd" title="Clear screen." alt="" coords="5,5,163,32"/>
</map>
</div>
</div>
</div>
<a id="a564dbe18e9c8dbf6c36c545dffdbbc6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a564dbe18e9c8dbf6c36c545dffdbbc6a">&#9670;&nbsp;</a></span>InputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::reference_wrapper&lt;std::istream&gt; neovision::IO::InputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get input stream. </p>
<p>This function provides low-level access to the current input stream.</p>
<dl class="section warning"><dt>Warning</dt><dd>You must use LockInputStream/UnlockInputStream around this call.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a reference to the current input stream. </dd></dl>
</div>
</div>
<a id="ada91295a45372b7c033e1eeb83f6cf3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada91295a45372b7c033e1eeb83f6cf3c">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void neovision::IO::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/dd1/classneovision_1_1_i_o.html">IO</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator (deleted). </p>
</div>
</div>
<a id="ac35d7ce7dffc8a039ed2649604f947e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac35d7ce7dffc8a039ed2649604f947e8">&#9670;&nbsp;</a></span>SetInputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neovision::IO::SetInputStream </td>
<td>(</td>
<td class="paramtype">std::istream &amp;&#160;</td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current input stream. </p>
<p>StdIn (std::cin) is the default input stream. This allows you to to override this to any input stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The new input stream to be used for text output. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d0/da4/crt_8cpp_source.html#l00068">68</a> of file <a class="el" href="../../d0/da4/crt_8cpp_source.html">crt.cpp</a>.</p>
</div>
</div>
<a id="af521c1e562851794e2241cb31b1a02ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af521c1e562851794e2241cb31b1a02ee">&#9670;&nbsp;</a></span>SetOutputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neovision::IO::SetOutputStream </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current output stream. </p>
<p>StdOut (std::cout) is the default output stream. This allows you to to override this to any output stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The new output stream to be used for text output. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d0/da4/crt_8cpp_source.html#l00074">74</a> of file <a class="el" href="../../d0/da4/crt_8cpp_source.html">crt.cpp</a>.</p>
</div>
</div>
<a id="afb4dc673ec628d7c25e94e7ea45cc624"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb4dc673ec628d7c25e94e7ea45cc624">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neovision::IO::Write </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write output. </p>
<p>Writes given string to the configured output stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>String to write to output stream. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d0/da4/crt_8cpp_source.html#l00080">80</a> of file <a class="el" href="../../d0/da4/crt_8cpp_source.html">crt.cpp</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../df/dd1/classneovision_1_1_i_o_afb4dc673ec628d7c25e94e7ea45cc624_icgraph.png" border="0" usemap="#df/dd1/classneovision_1_1_i_o_afb4dc673ec628d7c25e94e7ea45cc624_icgraph" alt=""/></div>
<map name="df/dd1/classneovision_1_1_i_o_afb4dc673ec628d7c25e94e7ea45cc624_icgraph" id="df/dd1/classneovision_1_1_i_o_afb4dc673ec628d7c25e94e7ea45cc624_icgraph">
<area shape="rect" title="Write output." alt="" coords="211,5,349,32"/>
<area shape="rect" href="../../d6/d46/namespaceneovision.html#a883665c96887ba19dc743ec8350cadcd" title="Clear screen." alt="" coords="5,5,163,32"/>
</map>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/neovision/<a class="el" href="../../d3/da1/crt_8h_source.html">crt.h</a></li>
<li>src/<a class="el" href="../../d0/da4/crt_8cpp_source.html">crt.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink