Menu Command Handlers

Functions
static ERR_te	menu_cmd_info_handler (uint32_t argc, char **argv)
	CLI handler for the "info" command. Logs the names of all active menu handles.
static ERR_te	menu_cmd_scroll_handler (uint32_t argc, char **argv)
	CLI handler for the "scroll" command. Scrolls a named menu and re-renders it.

Detailed Description

Function Documentation

menu_cmd_info_handler()

ERR_te menu_cmd_info_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "info" command. Logs the names of all active menu handles.

Expected invocation: menu info

Parameters

[in]	argc	Argument count. Must be exactly 2.
[in]	argv	Argument list: argv[0] = "menu", argv[1] = "info".

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 2

Definition at line 665 of file menu.c.

                                                                {
    if(argc != 2) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "menu_cmd_info_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    LOG_INFO(internal_state.subsys, internal_state.log_level, "Printing menu information:");
 
    for(uint32_t i = 0; i < CONFIG_MENU_MAX_OBJECTS; i++) {
        if(internal_state.menus[i].in_use == true) {
            LOG_INFO(
                internal_state.subsys,
                internal_state.log_level,
                "name: %s",
                internal_state.menus[i].name
            );
        }
    }
 
    return ERR_OK;
}

menu_cmd_scroll_handler()

ERR_te menu_cmd_scroll_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "scroll" command. Scrolls a named menu and re-renders it.

Expected invocation: menu scroll <n> <up|down>

Searches the registered menu pool for a handle whose name matches argv[2], calls menu_scroll in the specified direction, then calls menu_run_handle to update the display.

Parameters

[in]	argc	Argument count. Must be exactly 4.
[in]	argv	Argument list: argv[0] = "menu", argv[1] = "scroll", argv[2] = menu name, argv[3] = "up" or "down".

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 4, the name is not found, or the direction string is not recognized

Definition at line 711 of file menu.c.

                                                                  {
    if(argc != 4) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "menu_cmd_scroll_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    for(uint32_t i = 0; i < CONFIG_MENU_MAX_OBJECTS; i++) {
        if(str_cmp(argv[2], internal_state.menus[i].name) == true) {
            if(str_cmp(argv[3], "up") == true) {
                menu_scroll(&internal_state.menus[i], UP);
            }
            else if(str_cmp(argv[3], "down") == true) {
                menu_scroll(&internal_state.menus[i], DOWN);
            }
            else {
                LOG_ERROR(
                    internal_state.subsys,
                    internal_state.log_level,
                    "menu_cmd_scroll_handler: invalid arguments"
                );
                return ERR_INVALID_ARGUMENT;
            }
            menu_run_handle(&internal_state.menus[i]);
 
            return ERR_OK;
        }
        if(i == internal_state.menu_num - 1) {
            LOG_ERROR(
                internal_state.subsys,
                internal_state.log_level,
                "menu_cmd_scroll_handler: invalid arguments"
            );
 
            return ERR_INVALID_ARGUMENT;
        }
    }
 
    return ERR_OK;
}

Here is the call graph for this function: