X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_cmdline%2Fcmdline.h;h=2578ca816fabb95f232085b984192d14e4d365c5;hb=7f74b95c444f;hp=535a1191f3089b109def01610c8ebc1b92021271;hpb=3031749c2df04a63cdcef186dcce3781e61436e8;p=dpdk.git diff --git a/lib/librte_cmdline/cmdline.h b/lib/librte_cmdline/cmdline.h index 535a1191f3..2578ca816f 100644 --- a/lib/librte_cmdline/cmdline.h +++ b/lib/librte_cmdline/cmdline.h @@ -61,6 +61,15 @@ #ifndef _CMDLINE_H_ #define _CMDLINE_H_ +#include +#include + +/** + * @file + * + * Command line API + */ + #ifdef __cplusplus extern "C" { #endif @@ -71,17 +80,31 @@ struct cmdline { cmdline_parse_ctx_t *ctx; struct rdline rdl; char prompt[RDLINE_PROMPT_SIZE]; -#ifdef RTE_EXEC_ENV_LINUXAPP struct termios oldterm; -#endif }; struct cmdline *cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out); void cmdline_set_prompt(struct cmdline *cl, const char *prompt); void cmdline_free(struct cmdline *cl); -void cmdline_printf(const struct cmdline *cl, const char *fmt, ...); +void cmdline_printf(const struct cmdline *cl, const char *fmt, ...) + __attribute__((format(printf,2,3))); int cmdline_in(struct cmdline *cl, const char *buf, int size); int cmdline_write_char(struct rdline *rdl, char c); + +/** + * This function is nonblocking equivalent of ``cmdline_interact()``. It polls + * *cl* for one character and interpret it. If return value is *RDLINE_EXITED* + * it mean that ``cmdline_quit()`` was invoked. + * + * @param cl + * The command line object. + * + * @return + * On success return object status - one of *enum rdline_status*. + * On error return negative value. + */ +int cmdline_poll(struct cmdline *cl); + void cmdline_interact(struct cmdline *cl); void cmdline_quit(struct cmdline *cl);