kshell_cmds.h

Go to the documentation of this file.

#ifndef _KSHELL_CMDS_H
#define _KSHELL_CMDS_H
 
#include "io.h"
 
/**
 * @brief A pointer to a function for a shell command.
 * 
 * @param argc Number of arguments.
 * @param argv The arguments.
 * @param put The putchar function.
 * @return Return status.
 */
typedef int (*cmd_t)(int argc, const char *argv[], putchar put);
 
/**
 * @struct cmd_tbl_entry
 * @brief An entry for a shell command.
 */
struct cmd_tbl_entry {
        /** Name of the command. */
        const char *name;
        /** Function associated to the command. */
        cmd_t command;
        /** Description of the command. */
        const char *description;
};
 
/**
 * @brief Gets the cmd_t of a shell command, or NULL if not found.
 * 
 * @param name Name the command.
 */
cmd_t find_cmd(const char *name);
 
#endif // _KSHELL_CMDS_H