Subversion Repositories

?revision_form?Rev ?revision_input??revision_submit??revision_endform?

Blame | Last modification | View Log | RSS feed 

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 
<html><head>
<title>liboop: oop_readline_register(), oop_readline_cancel()</title>
<link rel="stylesheet" type="text/css" href="style.css">
</head><body>

<h2>oop_readline_register(), oop_readline_cancel()</h2>

<pre>
#include &lt;oop.h&gt;
#include &lt;oop-rl.h&gt;

void oop_readline_register(oop_source *source);
void oop_readline_cancel(oop_source *source);
</pre>

<h3>Arguments.</h3>

<dl>
<dt><b>oop_source *source</b>
<dd>The event source to use.  The adapter will use this event source to wait
asynchronously for console input.<p>
</dl>

<h3>Description.</h3>

<dl>
<dt><b>oop_readline_register</b>
<dd>Register a liboop <em>source</em> with the
<a href="http://cnswww.cns.cwru.edu/~chet/readline/rltop.html">GNU Readline 
Library</a>.  The adapter responds asynchronously to console input and notifies 
Readline when it arrives via rl_callback_read_char().  You should use the 
Readline <a href="http://cnswww.cns.cwru.edu/~chet/readline/readline.html#SEC38">alternate
interface</a> to prompt the user and receive input.<p>

Note well that Readline will
<a href="http://cnswww.cns.cwru.edu/~chet/readline/readline.html#SEC40">install
its own signal handlers</a> by default.  Make sure to disable this behavior
by setting rl_catch_signals to zero if you wish to manage signals with 
liboop.<p>

<dt><b>oop_readline_cancel</b>
<dd>Unregister liboop with Readline.  After this is called, 
rl_readback_read_char() will no longer be invoked automatically.<p>
</dl>

<hr><a href="ref">liboop reference</a></body></html>