Bob Nystrom
5098c37491
Remove the automatic fflush(stdout) call from the write() function in vm.c, which was causing gratuitous performance overhead on every System.write() invocation. Introduce a new Stdout class with a foreign static flush() method that delegates to fflush(stdout), giving users explicit control over when output is flushed. Update the io module registration in modules.c to include the Stdout class and bump MAX_CLASSES_PER_MODULE from 5 to 6. Add documentation for Stdout in doc/site/modules/io/stdout.markdown, update the io index and template to list the new class, and add flush() usage notes to the Stdin readByte() and readLine() docs. Implement the stdoutFlush() foreign function in io.c.
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
^title Stdin Class
|
|
|
|
The standard input stream.
|
|
|
|
## Static Methods
|
|
|
|
### **isRaw**
|
|
|
|
Returns `true` if stdin is in raw mode. When in raw mode, input is not echoed
|
|
or buffered, and all characters, even non-printing and control characters go
|
|
into stdin.
|
|
|
|
Defaults to `false`.
|
|
|
|
### **isRaw**=(value)
|
|
|
|
Sets raw mode on or off.
|
|
|
|
### **isTerminal**
|
|
|
|
Returns `true` if Stdin is connected to a "TTY". This is true when the user is
|
|
running Wren in an interactive terminal, and false if it its input is coming
|
|
from a pipe.
|
|
|
|
### **readByte**()
|
|
|
|
Reads one byte of input from stdin. Blocks the current fiber until a byte has
|
|
been received.
|
|
|
|
Returns the byte value as a number or `null` if stdin is closed.
|
|
|
|
Note that output is not automatically flushed when calling this. If you want to
|
|
display a prompt before reading input, you'll want to call `Stdout.flush()`
|
|
after printing the prompt.
|
|
|
|
### **readLine**()
|
|
|
|
Reads one line of input from stdin. Blocks the current fiber until a full line
|
|
of input has been received.
|
|
|
|
Returns the string of input or `null` if stdin is closed.
|
|
|
|
Note that output is not automatically flushed when calling this. If you want to
|
|
display a prompt before reading input, you'll want to call `Stdout.flush()`
|
|
after printing the prompt.
|