VSF Documented
Data Structures | Macros | Typedefs | Enumerations | Functions
esp_console_port.c File Reference
#include "../vsf_espidf_cfg.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <unistd.h>
#include <sys/param.h>
#include <fcntl.h>
#include "esp_console.h"
#include "esp_log.h"
#include "esp_system.h"
#include "linenoise.h"
#include "argtable3.h"
#include "esp_vfs_eventfd.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/semphr.h"
#include "shell/sys/linux/vsf_linux.h"

Data Structures

struct  esp_console_repl_com_t
 
struct  esp_console_repl_universal_t
 
struct  cmd_item_
 

Macros

#define ANSI_COLOR_DEFAULT   39
 
#define CONSOLE_PROMPT_MAX_LEN   32
 
#define CONSOLE_PATH_MAX_LEN   128
 
#define MAX(a, b)   (((a) > (b)) ? (a) : (b))
 
#define SS_FLAG_ESCAPE   0x8
 
#define END_ARG()
 

Typedefs

typedef struct cmd_item_ cmd_item_t
 
typedef void(*const fn_print_arg_t) (cmd_item_t *)
 

Enumerations

enum  repl_state_t {
  CONSOLE_REPL_STATE_DEINIT ,
  CONSOLE_REPL_STATE_INIT ,
  CONSOLE_REPL_STATE_START
}
 
enum  split_state_t {
  SS_SPACE = 0x0 ,
  SS_ARG = 0x1 ,
  SS_QUOTED_ARG = 0x2 ,
  SS_ARG_ESCAPED = SS_ARG | SS_FLAG_ESCAPE ,
  SS_QUOTED_ARG_ESCAPED = SS_QUOTED_ARG | SS_FLAG_ESCAPE
}
 

Functions

esp_err_t esp_console_internal_set_event_fd (esp_console_repl_com_t *repl_com)
 
size_t esp_console_split_argv (char *line, char **argv, size_t argv_size)
 
esp_err_t esp_console_init (const esp_console_config_t *config)
 
esp_err_t esp_console_deinit (void)
 
esp_err_t esp_console_cmd_deregister (const char *cmd_name)
 
esp_err_t esp_console_cmd_register (const esp_console_cmd_t *cmd)
 
void esp_console_get_completion (const char *buf, linenoiseCompletions *lc)
 
const char * esp_console_get_hint (const char *buf, int *color, int *bold)
 
esp_err_t esp_console_run (const char *cmdline, int *cmd_ret)
 
esp_err_t esp_console_register_help_command (void)
 
esp_err_t esp_console_deregister_help_command (void)
 
esp_err_t esp_console_set_help_verbose_level (esp_console_help_verbose_level_e verbose_level)
 
esp_err_t esp_console_delete_repl_stdio (esp_console_repl_t *repl)
 
esp_err_t esp_console_new_repl_stdio (const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl)
 
esp_err_t esp_console_start_repl (esp_console_repl_t *repl)
 
void linenoiseSetReadCharacteristics (void)
 
esp_err_t esp_console_stop_repl (esp_console_repl_t *repl)
 

Macro Definition Documentation

◆ ANSI_COLOR_DEFAULT

#define ANSI_COLOR_DEFAULT   39

◆ CONSOLE_PROMPT_MAX_LEN

#define CONSOLE_PROMPT_MAX_LEN   32

◆ CONSOLE_PATH_MAX_LEN

#define CONSOLE_PATH_MAX_LEN   128

◆ MAX

#define MAX (   a,
 
)    (((a) > (b)) ? (a) : (b))

◆ SS_FLAG_ESCAPE

#define SS_FLAG_ESCAPE   0x8

◆ END_ARG

#define END_ARG ( )
Value:
do { \
char_out = 0; \
argv[argc++] = next_arg_start; \
} while(0)
@ SS_SPACE
Definition esp_console_port.c:95
uint8_t state
Definition vsf_msg_tree.h:247

Typedef Documentation

◆ cmd_item_t

typedef struct cmd_item_ cmd_item_t

◆ fn_print_arg_t

typedef void(*const fn_print_arg_t) (cmd_item_t *)

Enumeration Type Documentation

◆ repl_state_t

Enumerator
CONSOLE_REPL_STATE_DEINIT 
CONSOLE_REPL_STATE_INIT 
CONSOLE_REPL_STATE_START 

◆ split_state_t

Enumerator
SS_SPACE 
SS_ARG 
SS_QUOTED_ARG 
SS_ARG_ESCAPED 
SS_QUOTED_ARG_ESCAPED 

Function Documentation

◆ esp_console_internal_set_event_fd()

esp_err_t esp_console_internal_set_event_fd ( esp_console_repl_com_t repl_com)

◆ esp_console_split_argv()

size_t esp_console_split_argv ( char *  line,
char **  argv,
size_t  argv_size 
)

◆ esp_console_init()

esp_err_t esp_console_init ( const esp_console_config_t config)

◆ esp_console_deinit()

esp_err_t esp_console_deinit ( void  )

◆ esp_console_cmd_deregister()

esp_err_t esp_console_cmd_deregister ( const char *  cmd_name)

◆ esp_console_cmd_register()

esp_err_t esp_console_cmd_register ( const esp_console_cmd_t cmd)

◆ esp_console_get_completion()

void esp_console_get_completion ( const char *  buf,
linenoiseCompletions lc 
)

◆ esp_console_get_hint()

const char * esp_console_get_hint ( const char *  buf,
int *  color,
int *  bold 
)

◆ esp_console_run()

esp_err_t esp_console_run ( const char *  cmdline,
int *  cmd_ret 
)

◆ esp_console_register_help_command()

esp_err_t esp_console_register_help_command ( void  )

◆ esp_console_deregister_help_command()

esp_err_t esp_console_deregister_help_command ( void  )

◆ esp_console_set_help_verbose_level()

esp_err_t esp_console_set_help_verbose_level ( esp_console_help_verbose_level_e  verbose_level)

◆ esp_console_delete_repl_stdio()

esp_err_t esp_console_delete_repl_stdio ( esp_console_repl_t repl)

◆ esp_console_new_repl_stdio()

esp_err_t esp_console_new_repl_stdio ( const esp_console_repl_config_t repl_config,
esp_console_repl_t **  ret_repl 
)

◆ esp_console_start_repl()

esp_err_t esp_console_start_repl ( esp_console_repl_t repl)

◆ linenoiseSetReadCharacteristics()

void linenoiseSetReadCharacteristics ( void  )

◆ esp_console_stop_repl()

esp_err_t esp_console_stop_repl ( esp_console_repl_t repl)

Variable Documentation

◆ help_cmd

struct arg_str* help_cmd

◆ verbose_level

struct arg_int* verbose_level

◆ end

struct arg_end* end
Generated from commit: vsfteam/vsf@c3767bf