<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Lwt_read_line.Command.html">
<link rel="next" href="Lwt_read_line.Terminal.html">
<link rel="Up" href="Lwt_read_line.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Lwt_condition" rel="Chapter" href="Lwt_condition.html">
<link title="Lwt_list" rel="Chapter" href="Lwt_list.html">
<link title="Lwt" rel="Chapter" href="Lwt.html">
<link title="Lwt_mutex" rel="Chapter" href="Lwt_mutex.html">
<link title="Lwt_mvar" rel="Chapter" href="Lwt_mvar.html">
<link title="Lwt_pool" rel="Chapter" href="Lwt_pool.html">
<link title="Lwt_sequence" rel="Chapter" href="Lwt_sequence.html">
<link title="Lwt_stream" rel="Chapter" href="Lwt_stream.html">
<link title="Lwt_switch" rel="Chapter" href="Lwt_switch.html">
<link title="Lwt_util" rel="Chapter" href="Lwt_util.html">
<link title="Lwt_pqueue" rel="Chapter" href="Lwt_pqueue.html">
<link title="Lwt_lib" rel="Chapter" href="Lwt_lib.html">
<link title="Lwt_glib" rel="Chapter" href="Lwt_glib.html">
<link title="Lwt_preemptive" rel="Chapter" href="Lwt_preemptive.html">
<link title="Lwt_event" rel="Chapter" href="Lwt_event.html">
<link title="Lwt_signal" rel="Chapter" href="Lwt_signal.html">
<link title="Lwt_react" rel="Chapter" href="Lwt_react.html">
<link title="Lwt_ssl" rel="Chapter" href="Lwt_ssl.html">
<link title="Lwt_text" rel="Chapter" href="Lwt_text.html">
<link title="Lwt_term" rel="Chapter" href="Lwt_term.html">
<link title="Lwt_read_line" rel="Chapter" href="Lwt_read_line.html">
<link title="Lwt_top" rel="Chapter" href="Lwt_top.html">
<link title="Lwt_chan" rel="Chapter" href="Lwt_chan.html">
<link title="Lwt_daemon" rel="Chapter" href="Lwt_daemon.html">
<link title="Lwt_gc" rel="Chapter" href="Lwt_gc.html">
<link title="Lwt_io" rel="Chapter" href="Lwt_io.html">
<link title="Lwt_log" rel="Chapter" href="Lwt_log.html">
<link title="Lwt_main" rel="Chapter" href="Lwt_main.html">
<link title="Lwt_process" rel="Chapter" href="Lwt_process.html">
<link title="Lwt_throttle" rel="Chapter" href="Lwt_throttle.html">
<link title="Lwt_timeout" rel="Chapter" href="Lwt_timeout.html">
<link title="Lwt_unix" rel="Chapter" href="Lwt_unix.html">
<link title="Lwt_sys" rel="Chapter" href="Lwt_sys.html">
<link title="Lwt_engine" rel="Chapter" href="Lwt_engine.html">
<link title="Lwt_bytes" rel="Chapter" href="Lwt_bytes.html">
<link title="Pa_lwt" rel="Chapter" href="Pa_lwt.html">
<link title="Pa_lwt_log" rel="Chapter" href="Pa_lwt_log.html"><title>Lwt_read_line.Engine</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Lwt_read_line.Command.html" title="Lwt_read_line.Command">Previous</a>
<a class="up" href="Lwt_read_line.html" title="Lwt_read_line">Up</a>
<a class="post" href="Lwt_read_line.Terminal.html" title="Lwt_read_line.Terminal">Next</a>
</div>
<h1>Module <a href="type_Lwt_read_line.Engine.html">Lwt_read_line.Engine</a></h1>
<pre><span class="keyword">module</span> Engine: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_read_line.Engine.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Engine<br>
</div>
<hr width="100%">
<br>
Note: this part know nothing about rendering or completion.<br>
<pre><code><span id="TYPEselection_state"><span class="keyword">type</span> <code class="type"></code>selection_state</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTselection_state.sel_text">sel_text</span> :<code class="type">Text.t</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The whole input text on which the selection is working</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTselection_state.sel_mark">sel_mark</span> :<code class="type">Text.pointer</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Pointer to the mark</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTselection_state.sel_cursor">sel_cursor</span> :<code class="type">Text.pointer</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Pointer to the cursor</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
State when the user is doing selection:<br>
</div>
<pre><code><span id="TYPEsearch_state"><span class="keyword">type</span> <code class="type"></code>search_state</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsearch_state.search_word">search_word</span> :<code class="type">Text.t</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The word we are looking for</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsearch_state.search_history">search_history</span> :<code class="type"><a href="Lwt_read_line.html#TYPEhistory">Lwt_read_line.history</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Position in history. The first element is a sentence
containing the searched word</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsearch_state.search_init_history">search_init_history</span> :<code class="type"><a href="Lwt_read_line.html#TYPEhistory">Lwt_read_line.history</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The initial history, before searching for a word</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
State when searching in the history<br>
</div>
<pre><code><span id="TYPEmode"><span class="keyword">type</span> <code class="type"></code>mode</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmode.Edition"><span class="constructor">Edition</span></span> <span class="keyword">of</span> <code class="type"><a href="Lwt_read_line.html#TYPEedition_state">Lwt_read_line.edition_state</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The user is typing some text</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmode.Selection"><span class="constructor">Selection</span></span> <span class="keyword">of</span> <code class="type"><a href="Lwt_read_line.Engine.html#TYPEselection_state">selection_state</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The user is selecting some text</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmode.Search"><span class="constructor">Search</span></span> <span class="keyword">of</span> <code class="type"><a href="Lwt_read_line.Engine.html#TYPEsearch_state">search_state</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The user is searching the given word in the history</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
The engine mode:<br>
</div>
<pre><code><span id="TYPEstate"><span class="keyword">type</span> <code class="type"></code>state</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstate.mode">mode</span> :<code class="type"><a href="Lwt_read_line.Engine.html#TYPEmode">mode</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTstate.history">history</span> :<code class="type"><a href="Lwt_read_line.html#TYPEhistory">Lwt_read_line.history</a> * <a href="Lwt_read_line.html#TYPEhistory">Lwt_read_line.history</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Cursor to the history position.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
An engine state:<br>
</div>
<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type"><a href="Lwt_read_line.html#TYPEhistory">Lwt_read_line.history</a> -> <a href="Lwt_read_line.Engine.html#TYPEstate">state</a></code></pre><div class="info">
<code class="code">init history</code> return a initial state using the given
history<br>
</div>
<pre><span id="VALreset"><span class="keyword">val</span> reset</span> : <code class="type"><a href="Lwt_read_line.Engine.html#TYPEstate">state</a> -> <a href="Lwt_read_line.Engine.html#TYPEstate">state</a></code></pre><div class="info">
<code class="code">reset state</code> reset the given state, if the user was doing a
selection, it is canceled<br>
</div>
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type">engine_state:<a href="Lwt_read_line.Engine.html#TYPEstate">state</a> -><br> ?clipboard:<a href="Lwt_read_line.clipboard-c.html">Lwt_read_line.clipboard</a> -><br> command:<a href="Lwt_read_line.Command.html#TYPEt">Lwt_read_line.Command.t</a> -> unit -> <a href="Lwt_read_line.Engine.html#TYPEstate">state</a></code></pre><div class="info">
<code class="code">update ~state ?clipboard ~command ()</code> update an engine state by
processing the given command. It returns the new state, and
may have the side effect of changing the clipboard contents.
<p>
<code class="code">clipboard</code> defaults to the global clipboard.<br>
</div>
<pre><span id="VALedition_state"><span class="keyword">val</span> edition_state</span> : <code class="type"><a href="Lwt_read_line.Engine.html#TYPEstate">state</a> -> <a href="Lwt_read_line.html#TYPEedition_state">Lwt_read_line.edition_state</a></code></pre><div class="info">
Returns the edition state of a state, whatever its mode is.<br>
</div>
<pre><span id="VALall_input"><span class="keyword">val</span> all_input</span> : <code class="type"><a href="Lwt_read_line.Engine.html#TYPEstate">state</a> -> Text.t</code></pre><div class="info">
Returns the current complete user input.<br>
</div>
</body></html>
