File: tty_read.doc

package info (click to toggle)
hol88 2.02.19940316dfsg-5
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 65,816 kB
  • sloc: ml: 199,939; ansic: 9,666; sh: 6,913; makefile: 6,032; lisp: 2,747; yacc: 894; sed: 201; cpp: 87; awk: 5
file content (37 lines) | stat: -rw-r--r-- 929 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
\DOC tty_read

\TYPE {tty_read : (void -> string)}

\SYNOPSIS
Reads a single character from the standard input.

\KEYWORDS
file.

\DESCRIBE
The call {tty_read()} will read a single character from the standard input,
which in an interactive HOL session will normally be the terminal.

\FAILURE
Will only fail under obscure system-dependent circumstances.

\EXAMPLE
The following example shows how a check on the deletion of a file might be
implemented:
{
   #tty_write `Delete GONK.th (y/n)?`;
   #tty_read()=`y` => unlink `GONK.th` | ();;
   Delete GONK.th (y/n)?n
   () : void
   Run time: 0.0s
}
\COMMENTS
Only one character is read per call of {tty_read()}, and remaining characters
will be passed to the ML interpreter as usual. It is of course possible to make
multiple calls to {tty_read()} (e.g. via a {while} loop) to read in a longer
string.

\SEEALSO
append_openw, close, openi, openw, read, tty_write, write.

\ENDDOC