getch, mvgetch, mvwgetch o wgetch Subroutine

Finalidad

Obtiene un carácter de un solo byte del terminal.

Biblioteca

Biblioteca de curses (libcurses.a)

Sintaxis

#include <curses.h>

int getch(void)

int mvgetch(int y,
int x);

int mvwgetch(WINDOW *win,
int y,
int x);

int wgetch(WINDOW *win);

Descripción

Las subrutinas getch, wgetch, mvgetchy mvwgetch leen un carácter de un solo byte del terminal asociado con la ventana actual o especificada. Los resultados no se especifican si la entrada no es un carácter de un solo byte. Si la subrutina teclado está habilitada, estas subrutinas responden al valor KEY_ correspondiente definido en <curses.h>.

El proceso de entrada de terminal está sujeto a las reglas generales descritas en la sección 3.5 de la página 34.

Si el eco está habilitado, el carácter se repite como si se hubiera proporcionado como argumento de entrada a la subrutina addch , excepto para los caracteres siguientes:

<backspace>,

<left-arrow> and 

the current erase character:

La entrada se interpreta como se especifica en la sección 3.4.3 en la página 31 y, a continuación, el carácter en la posición del cursor resultante se suprime como si se llamara a la subrutina delch , excepto que si el cursor estaba originalmente en la primera columna de la línea, se avisa al usuario como si se llamara a la subrutina beep .

Se alerta al usuario como si se llamara a la subrutina beep . La información relativa a las teclas de función no se devuelve al interlocutor.

Teclas de función

Si la ventana actual o especificada no es un relleno, y se ha movido o modificado desde la última operación de renovación, se renovará antes de que se lea otro carácter.

Importancia de las modalidades de terminal

La salida de las subrutinas getch está, en parte, determinada por la modalidad del terminal. A continuación se describe la acción de las subrutinas getch en cada tipo de modalidad de terminal:

Cómo obtener teclas de función

Si el programa habilita el teclado con la subrutina teclado y el usuario pulsa una tecla de función, se devuelve la señal para dicha tecla de función en lugar de caracteres sin formato. Las claves de función posibles se definen en el archivo /usr/include/curses.h . Cada macro #define empieza con un prefijo KEY_ .

Si se recibe un carácter que podría ser el principio de una tecla de función (como un carácter de escape), las maldiciones establecen un temporizador. Si el resto de la secuencia no se recibe antes de que caduque el temporizador, se pasa el carácter. De lo contrario, se devuelve el valor de la tecla de función. Por esta razón, después de que un usuario pulse la tecla Esc, se produce un retardo antes de que se devuelva el escape al programa. Los programadores no deben utilizar la tecla Esc para una rutina de un solo carácter.

Dentro de la subrutina getch , una estructura de tipo timeval, definida en el archivo /usr/include/sys/time.h , indica el número máximo de microsegundos que se debe esperar a que se complete la respuesta de clave.

La variable de entorno ESCDELAY establece el periodo de tiempo que se debe esperar antes de exceder el tiempo de espera y tratar la pulsación ESC como el carácter ESC en lugar de combinarla con otros caracteres del almacenamiento intermedio para crear una secuencia de teclas. La variable de entorno ESCDELAY se mide en quintas partes de un milisegundo. Si ESCDELAY es 0, el sistema compone inmediatamente la respuesta ESCAPE sin esperar a obtener más información del almacenamiento intermedio. El usuario puede elegir cualquier valor entre 0 y 99.999, ambos inclusive. El valor predeterminado para la variable de entorno ESCDELAY es 500 (una décima parte de un segundo).

Los programas que no desean que las subrutinas getch establezcan un temporizador pueden llamar a la subrutina notimeout . Si notimeout se establece en TRUE, las curses no distinguen entre teclas de función y caracteres al recuperar datos.

Es posible que las subrutinas getch no puedan devolver todas las teclas de función porque no están definidas en la base de datos terminfo o porque el terminal no transmite un código exclusivo cuando se pulsa la tecla. Las subrutinas getch pueden devolver las siguientes teclas de función:

Parámetros

Valores de retorno

Tras una finalización satisfactoria, las subrutinas getch, mvwgetch y wgetch , CURSES y Curses Interface devuelven el carácter de un solo byte, KEY_ value o ERR. Cuando está en modalidad de no retardo y no hay datos disponibles, se devuelve ERR.

Ejemplos

1. Para obtener un carácter y hacerlo eco en el stdscr, utilice:

   mvgetch();

2. Para obtener un carácter y hacer eco de él en stdscr en las coordenadas y=20, x=30, utilice:

   mvgetch(20, 30);

3. Para obtener un carácter y hacerlo eco en la ventana definida por el usuariomy_windowen las coordenadas y=20, x=30, utilice:

   WINDOW *my_window;
   mvwgetch(my_window, 20, 30);