menu: add library to handle commands
This commit is contained in:
parent
25c44e9568
commit
afb39f2dd0
|
|
@ -0,0 +1,115 @@
|
|||
/* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** definitions to build menus (code)
|
||||
* @file menu.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2018
|
||||
*/
|
||||
/* standard libraries */
|
||||
#include <stdint.h> // standard integer types
|
||||
#include <stdbool.h> // boolean types
|
||||
#include <stdlib.h> // standard utilities
|
||||
#include <string.h> // string utilities
|
||||
|
||||
/* own libraries */
|
||||
#include "menu.h" // definitions for the menu
|
||||
#include "print.h" // print utilities
|
||||
|
||||
bool menu_handle_command(char* line, const struct menu_command_t* command_list, size_t command_list_length)
|
||||
{
|
||||
// ensure line is not empty
|
||||
if (!line || 0==strlen(line)) {
|
||||
return false;
|
||||
}
|
||||
// ensure command are available
|
||||
if (NULL==command_list || 0==command_list_length) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// get command
|
||||
const char* delimiter = " "; // words are separated by spaces
|
||||
char* word = strtok(line, delimiter); // get first word
|
||||
if (!word) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// find corresponding command
|
||||
bool command_found = false; // remember if we found the corresponding command
|
||||
for (size_t i=0; i<command_list_length; i++) { // go through available command list
|
||||
struct menu_command_t command = command_list[i]; // get current command
|
||||
if ((1==strlen(word) && command.shortcut==word[0]) || 0==strcmp(word, command.name)) { // check if shortcut or name match
|
||||
command_found = true; // remember we found the command
|
||||
if (command.command_handler) { // ensure there is an command handler
|
||||
if (MENU_ARGUMENT_NONE==command.argument) { // check if argument can be passed
|
||||
(*command.command_handler)(NULL); // call without argument
|
||||
} else { // argument can be passed
|
||||
word = strtok(NULL, delimiter); // get next word
|
||||
if (!word) { // no argument provided
|
||||
(*command.command_handler)(NULL); // call without argument
|
||||
} else if (MENU_ARGUMENT_SIGNED==command.argument) { // next argument should be a signed integer
|
||||
int32_t argument = atoi(word); // get signed integer
|
||||
(*command.command_handler)(&argument); // call with argument
|
||||
} else if (MENU_ARGUMENT_UNSIGNED==command.argument) { // next argument should be an unsigned integer
|
||||
uint32_t argument = atoi(word); // get unsigned integer
|
||||
(*command.command_handler)(&argument); // call with argument
|
||||
} else if (MENU_ARGUMENT_FLOAT==command.argument) { // next argument should be a floating point number
|
||||
double argument = atof(word); // get floating point number
|
||||
(*command.command_handler)(&argument); // call with argument
|
||||
} else if (MENU_ARGUMENT_STRING==command.argument) { // next argument should be a string
|
||||
(*command.command_handler)(word); // call with argument
|
||||
}
|
||||
}
|
||||
}
|
||||
break; // stop searching for the command
|
||||
}
|
||||
}
|
||||
|
||||
// find default command
|
||||
if (!command_found) { // we didn't find the corresponding command
|
||||
for (size_t i=0; i<command_list_length; i++) { // go through available command list
|
||||
struct menu_command_t command = command_list[i]; // get current command
|
||||
if (0==command.shortcut && NULL==command.name) { // check if there is a default command
|
||||
command_found = true; // remember we found the command
|
||||
if (command.command_handler) { // ensure there is an command handler
|
||||
(*command.command_handler)(word); // call with current word
|
||||
}
|
||||
break; // stop searching for the command
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return command_found;
|
||||
}
|
||||
|
||||
void menu_print_commands(const struct menu_command_t* command_list, size_t command_list_length)
|
||||
{
|
||||
for (size_t i=0; i<command_list_length; i++) {
|
||||
struct menu_command_t command = command_list[i];
|
||||
if (command.name) {
|
||||
if (command.shortcut) {
|
||||
printf("%c|", command.shortcut);
|
||||
}
|
||||
printf("%s", command.name);
|
||||
if (MENU_ARGUMENT_NONE!=command.argument && command.argument_description) {
|
||||
printf(" %s", command.argument_description);
|
||||
}
|
||||
if (command.command_description) {
|
||||
printf("\t%s", command.command_description);
|
||||
}
|
||||
printf("\n");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
/* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
/** definitions to build menus (API)
|
||||
* @file menu.h
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2018
|
||||
*/
|
||||
|
||||
/** types of argument accepted by the command */
|
||||
enum menu_argument_t {
|
||||
MENU_ARGUMENT_NONE, /**< no argument accepted */
|
||||
MENU_ARGUMENT_SIGNED, /**< int32 argument accepted */
|
||||
MENU_ARGUMENT_UNSIGNED, /**< uint32 argument accepted */
|
||||
MENU_ARGUMENT_FLOAT, /**< double argument accepted */
|
||||
MENU_ARGUMENT_STRING, /**< string argument accepted */
|
||||
};
|
||||
|
||||
/** command menu entry */
|
||||
struct menu_command_t {
|
||||
char shortcut; /**< short command code (0 if not available) */
|
||||
char* name; /**< complete name of the command (space-free) */
|
||||
char* command_description; /**< human readable description of the command purpose */
|
||||
enum menu_argument_t argument; /**< what kind of argument it accepts */
|
||||
char* argument_description; /**< human readable description of the argument it can accept */
|
||||
void (*command_handler)(void* argument); /**< function to be called to handle this command */
|
||||
};
|
||||
|
||||
/** parse command from line and call corresponding command
|
||||
* @param[in] line use input to parse
|
||||
* @param[in] command_list list of available commands
|
||||
* @prarm[in] command_list_length number of available commands
|
||||
* @return if an command corresponding to the line has been found and called
|
||||
*/
|
||||
bool menu_handle_command(char* line, const struct menu_command_t* command_list, size_t command_list_length);
|
||||
/** print the commands from the command list
|
||||
* @param[in] command_list list of available commands
|
||||
* @prarm[in] command_list_length number of available commands
|
||||
*/
|
||||
void menu_print_commands(const struct menu_command_t* command_list, size_t command_list_length);
|
||||
|
||||
Loading…
Reference in New Issue