cne_tty.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 */
 
#ifndef __CNE_TTY_H_
#define __CNE_TTY_H_
 
// IWYU pragma: no_include <bits/termios-struct.h>
 
#include <termios.h>
#include <signal.h>            // for sigaction
#include <stdarg.h>            // for va_list
#include <stdint.h>            // for uint16_t
#include <stdio.h>             // for FILE
#include <string.h>            // for strlen
#include <unistd.h>            // for read, write
#include <cne_atomic.h>        // for CNE_ATOMIC
#include <cne_common.h>
#include <cne_system.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define TTY_BUFF_SIZE    1024
#define TTY_MAX_CMD_SIZE 16
 
typedef union {
    int val;
    struct {
        uint16_t nrows; 
        uint16_t ncols; 
    };
} tty_wsize_t;
 
typedef struct {
    int flags;                       
    int fd_out;                      
    int fd_in;                       
    struct sigaction saved_action;   
    CNE_ATOMIC(uint_fast16_t) winsz; 
    tty_wsize_t wsize;               
    struct termios oldterm;          
    CNE_ATOMIC(int_least32_t) pause; 
} cne_tty_t;
 
enum {
    TTY_IS_INITED  = (1 << 0),
    TTY_IS_A_TTY   = (1 << 1),
    TTY_COLOR_ON   = (1 << 2),
    TTY_WS_CHANGED = (1 << 8),
};
 
extern cne_tty_t *this_tty;
 
CNDP_API int tty_setup(int fd_in, int fd_out);
 
CNDP_API void tty_destroy(void);
 
CNDP_API void tty_enable_color(void);
 
CNDP_API void tty_disable_color(void);
 
CNDP_API int tty_is_color_on(void);
 
CNDP_API int tty_is_inited(void);
 
CNDP_API void tty_set_wchanged(void);
 
CNDP_API void tty_clear_wchanged(void);
 
CNDP_API int tty_did_wchange(void);
 
CNDP_API tty_wsize_t *tty_window_size(void);
 
CNDP_API int tty_num_rows(void);
 
CNDP_API int tty_num_columns(void);
 
CNDP_API int tty_poll(char *buf, int len, int timeout);
 
CNDP_API int tty_write(const char *buf, int len);
 
CNDP_API int tty_dwrite(int fd, const char *buf, int len);
 
CNDP_API int tty_fwrite(FILE *f, const char *buf, int len);
 
CNDP_API int tty_read(char *buf, int len);
 
CNDP_API int tty_dread(int fd, char *buf, int len);
 
CNDP_API int tty_fread(FILE *f, char *buf, int len);
 
CNDP_API int tty_printf(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
 
CNDP_API int tty_fprintf(FILE *f, const char *fmt, ...) __attribute__((format(printf, 2, 0)));
 
CNDP_API int tty_vprintf(const char *fmt, va_list ap) __attribute__((format(printf, 1, 0)));
 
CNDP_API int tty_vfprintf(FILE *f, const char *fmt, va_list ap)
    __attribute__((format(printf, 2, 0)));
 
#ifdef __cplusplus
}
#endif
 
#endif /* __CNE_TTY_H_ */