summaryrefslogtreecommitdiff
path: root/ext/io/console/console.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/io/console/console.c')
-rw-r--r--ext/io/console/console.c26
1 files changed, 26 insertions, 0 deletions
diff --git a/ext/io/console/console.c b/ext/io/console/console.c
index 6fa0e906ac..cd5ffd94fb 100644
--- a/ext/io/console/console.c
+++ b/ext/io/console/console.c
@@ -247,6 +247,8 @@ ttymode(VALUE io, VALUE (*func)(VALUE), void (*setter)(conmode *))
* STDIN.raw(&:gets)
*
* will read and return a line with echo back and line editing.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_raw(VALUE io)
@@ -261,6 +263,8 @@ console_raw(VALUE io)
* Enables raw mode.
*
* If the terminal mode needs to be back, use io.raw { ... }.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_set_raw(VALUE io)
@@ -288,6 +292,8 @@ getc_call(VALUE io)
* io.getch -> char
*
* Reads and returns a character in raw mode.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_getch(VALUE io)
@@ -304,6 +310,8 @@ console_getch(VALUE io)
* STDIN.noecho(&:gets)
*
* will read and return a line without echo back.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_noecho(VALUE io)
@@ -316,6 +324,8 @@ console_noecho(VALUE io)
* io.echo = flag
*
* Enables/disables echo back.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_set_echo(VALUE io, VALUE f)
@@ -340,6 +350,8 @@ console_set_echo(VALUE io, VALUE f)
* io.echo? -> true or false
*
* Returns +true+ if echo back is enabled.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_echo_p(VALUE io)
@@ -379,6 +391,8 @@ typedef CONSOLE_SCREEN_BUFFER_INFO rb_console_size_t;
* io.winsize -> [rows, columns]
*
* Returns console size.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_winsize(VALUE io)
@@ -399,6 +413,8 @@ console_winsize(VALUE io)
*
* Tries to set console size. The effect depends on the platform and
* the running environment.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_set_winsize(VALUE io, VALUE size)
@@ -410,7 +426,9 @@ console_set_winsize(VALUE io, VALUE size)
int newrow, newcol;
#endif
VALUE row, col, xpixel, ypixel;
+#if defined TIOCSWINSZ
int fd;
+#endif
GetOpenFile(io, fptr);
size = rb_Array(size);
@@ -456,6 +474,8 @@ console_set_winsize(VALUE io, VALUE size)
* io.iflush
*
* Flushes input buffer in kernel.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_iflush(VALUE io)
@@ -476,6 +496,8 @@ console_iflush(VALUE io)
* io.oflush
*
* Flushes output buffer in kernel.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_oflush(VALUE io)
@@ -496,6 +518,8 @@ console_oflush(VALUE io)
* io.ioflush
*
* Flushes input and output buffers in kernel.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_ioflush(VALUE io)
@@ -525,6 +549,8 @@ console_ioflush(VALUE io)
* IO.console -> #<File:/dev/tty>
*
* Returns an File instance opened console.
+ *
+ * You must require 'io/console' to use this method.
*/
static VALUE
console_dev(VALUE klass)