Symbols

loading...

Files

loading...

Summary Syntax Related References Instances Lifecycle

SourceVuESP-IDF Framework and ExamplesESP-IDFcmd_item_

cmd_item_ struct

Default foreground color

Syntax

Show:

Summary

Declaration

from commands.c:21

typedef struct cmd_item_ { const char *command; const char *help; char *hint; esp_console_cmd_func_t func; esp_console_cmd_func_with_context_t func_w_context; void *argtable; void *context; SLIST_ENTRY(cmd_item_) next; } cmd_item_t;

Fields

Field

Declared as

Description

cmd_item_::command

const char *

Command name (statically allocated by application).

cmd_item_::help

const char *

Help text (statically allocated by application), may be NULL.

cmd_item_::hint

char *

Hint text, usually lists possible arguments, dynamically allocated. May be NULL.

cmd_item_::func

esp_console_cmd_func_t

cmd_item_::func_w_context

esp_console_cmd_func_with_context_t

cmd_item_::argtable

void *

cmd_item_::context

void *

cmd_item_::next

SLIST_ENTRY(cmd_item_)

References

Code

Location

Scope

Referrer

typedef struct cmd_item_ {

SLIST_ENTRY(cmd_item_) next; //!< next command in the list

typedef void (*const fn_print_arg_t)(cmd_item_t*);

static SLIST_HEAD(cmd_list_, cmd_item_) s_cmd_list;

static const cmd_item_t *find_command_by_name(const char *name);

find_command_by_name()

cmd_item_t *it, *tmp;

esp_console_deinit()

SLIST_REMOVE(&s_cmd_list, it, cmd_item_, next);

esp_console_deinit()

free(it);

esp_console_deinit()

void esp_console_rm_item_free_hint(cmd_item_t *item)

esp_console_rm_item_free_hint()

esp_console_rm_item_free_hint()::item

SLIST_REMOVE(&s_cmd_list, item, cmd_item_, next);

esp_console_rm_item_free_hint()

cmd_item_t *item = (cmd_item_t *)find_command_by_name(cmd_name);

esp_console_cmd_deregister()

cmd_item_t *item = NULL;

esp_console_cmd_register()

item = (cmd_item_t *)find_command_by_name(cmd->command);

esp_console_cmd_register()

cmd_item_t *last;

esp_console_cmd_register()

cmd_item_t *it;

esp_console_cmd_register()

cmd_item_t *it;

esp_console_get_completion()

cmd_item_t *it;

esp_console_get_hint()

static const cmd_item_t *find_command_by_name(const char *name)

find_command_by_name()

const cmd_item_t *cmd = NULL;

find_command_by_name()

cmd_item_t *it;

find_command_by_name()

const cmd_item_t *cmd = find_command_by_name(argv[0]);

esp_console_run()

static void print_arg_help(cmd_item_t *it)

print_arg_help()

print_arg_help()::it

static void print_arg_command(cmd_item_t *it)

print_arg_command()

print_arg_command()::it

cmd_item_t *it;

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

return

find_command_by_name()

esp_console_rm_item_free_hint()::item

esp_console_rm_item_free_hint()

return

find_command_by_name()

print_arg_help()::it

print_arg_help()

print_arg_command()::it

print_arg_command()

Lifecycle

cmd_item_ is freed by 1 symbol:

cmd_item_

esp_console_deinit()