cli_input.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 */
 
#ifndef _CLI_INPUT_H_
#define _CLI_INPUT_H_
 
#include <strings.h>        // for index
#include <stdint.h>         // for uint32_t
#include <stdio.h>          // for FILE
#include <stdlib.h>         // for atoi
#include <string.h>         // for memset
 
#include "cli.h"        // for cli, this_cli, cli_clr_flag, cli_tst_flag
#include "cli_common.h"
#include "cli_gapbuf.h"        // for gb_data_size, gb_left_data_size, gb_point_of...
#include "cne_log.h"
#include "cne_common.h"        // for CNDP_API
#include "cne_stdio.h"         // for cne_printf
#include "cne_tty.h"           // for tty_write, tty_num_columns, tty_read
#include "vt100_out.h"         // for vt_bol, vt_cnright, vt_cpos, vt100_clear_line
 
#ifdef __cplusplus
extern "C" {
#endif
 
CNDP_API int cli_poll(char *c);
 
/* Report Cursor Position   <ESC>[{ROW};{COLUMN}R
   Generated by the device in response to a Query Cursor Position request;
   reports current cursor position. */
static inline void
cli_get_cursor(int *row, int *col)
{
    char buf[32], *p, ch;
    int r, c, l;
 
again:
    vt_cpos();
 
    memset(buf, 0, sizeof(buf));
    p = buf;
    l = sizeof(buf) - 1;
 
    do {
        tty_read(&ch, 1);
        if (ch == 'R')
            break;
        if (ch == '\0')
            continue;
        *p++ = ch;
    } while (l--);
 
    p = index(buf, ';');
    if (!p)
        goto again;
 
    r = atoi(&buf[2]);
    c = atoi(++p);
    if (!r || !c)
        goto again;
 
    *row = r;
    *col = c;
}
 
static inline void
cli_cursor_left(void)
{
    tty_write(vt100_left_arr, -1);
}
 
static inline void
cli_cursor_right(void)
{
    tty_write(vt100_right_arr, -1);
}
 
static inline void
cli_save_cursor(void)
{
    tty_write(vt100_save_cursor, -1);
}
 
static inline void
cli_restore_cursor(void)
{
    tty_write(vt100_restore_cursor, -1);
}
 
static inline void
cli_display_left(void)
{
    if (gb_left_data_size(this_cli->gb))
        tty_write(gb_start_of_buf(this_cli->gb), gb_left_data_size(this_cli->gb));
}
 
static inline void
cli_display_right(void)
{
    if (gb_right_data_size(this_cli->gb))
        tty_write(gb_end_of_gap(this_cli->gb), gb_right_data_size(this_cli->gb));
}
 
static inline void
cli_clear_screen(void)
{
    tty_write(vt100_clear_screen, -1);
}
 
static inline void
cli_clear_to_eol(void)
{
    tty_write(vt100_clear_right, -1);
}
 
static inline void
cli_clear_line(int lineno)
{
    if (lineno > 0)
        cne_printf(vt100_pos_cursor, lineno, 0);
    else
        tty_write("\r", 1);
 
    tty_write(vt100_clear_line, -1);
}
 
static inline void
cli_move_cursor_up(int lineno)
{
    while (lineno--)
        cne_printf(vt100_up_arr);
}
 
static inline void
cli_display_prompt(int t)
{
    tty_write("\r", 1);
    this_cli->plen = this_cli->prompt(t);
    cli_clear_to_eol();
}
 
/* display all or part of the command line, while allowing the line to scroll */
static inline void
cli_display_line(void)
{
    struct gapbuf *gb = this_cli->gb;
    char buf[gb_data_size(gb) + 16];
    int point  = gb_point_offset(gb);
    int len    = gb_copy_to_buf(gb, buf, gb_data_size(gb));
    int window = (tty_num_columns() - this_cli->plen) - 1;
    int wstart, wend;
 
    if (cli_tst_flag(DELETE_CHAR)) {
        cli_clr_flag(DELETE_CHAR);
        tty_write(" \b", 2);
        cli_set_flag(CLEAR_TO_EOL);
    }
    if (cli_tst_flag(CLEAR_LINE)) {
        cli_clr_flag(CLEAR_LINE);
        vt_bol();
        cli_clear_to_eol();
        cli_set_flag(DISPLAY_PROMPT);
    }
    if (cli_tst_flag(CLEAR_TO_EOL)) {
        cli_clr_flag(CLEAR_TO_EOL);
        cli_clear_to_eol();
    }
    if (cli_tst_flag(DISPLAY_PROMPT)) {
        cli_clr_flag(DISPLAY_PROMPT | PROMPT_CONTINUE);
        cli_display_prompt(0);
    }
 
    if (point < window) {
        wstart = 0;
        if (len < window)
            wend = point + (len - point);
        else
            wend = point + (window - point);
    } else {
        wstart = point - window;
        wend   = wstart + window;
    }
 
    vt_bol();
    vt_cnright(this_cli->plen);
 
    (void)wend;
    tty_write(&buf[wstart], wend - wstart);
 
    cli_clear_to_eol();
 
    vt_bol();
    vt_cnright(this_cli->plen + point);
}
 
static inline void
cli_redisplay_line(void)
{
    uint32_t i;
 
    this_cli->flags |= DISPLAY_PROMPT;
 
    cli_display_line();
 
    gb_move_gap_to_point(this_cli->gb);
 
    for (i = 0; i < (gb_data_size(this_cli->gb) - gb_point_offset(this_cli->gb)); i++)
        cli_cursor_left();
}
 
CNDP_API void cli_input(char *str, int n, int silent);
 
CNDP_API cli_prompt_t cli_set_prompt(cli_prompt_t prompt);
 
CNDP_API void cli_set_io(FILE *in, FILE *out);
 
CNDP_API int cli_stdin_setup(void);
 
CNDP_API void cli_stdin_restore(void);
 
CNDP_API char cli_pause(const char *msg, const char *keys);
 
CNDP_API int cli_yield_io(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CLI_INPUT_H_ */