lib/librte_cmdline/cmdline_rdline.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  36  * All rights reserved.
  37  * Redistribution and use in source and binary forms, with or without
  38  * modification, are permitted provided that the following conditions are met:
  39  *
  40  *     * Redistributions of source code must retain the above copyright
  41  *       notice, this list of conditions and the following disclaimer.
  42  *     * Redistributions in binary form must reproduce the above copyright
  43  *       notice, this list of conditions and the following disclaimer in the
  44  *       documentation and/or other materials provided with the distribution.
  45  *     * Neither the name of the University of California, Berkeley nor the
  46  *       names of its contributors may be used to endorse or promote products
  47  *       derived from this software without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  50  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  51  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  52  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  53  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  54  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  55  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  56  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  57  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  58  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  59  */
  60
  61 #ifndef _RDLINE_H_
  62 #define _RDLINE_H_
  63
  64 /**
  65  * This file is a small equivalent to the GNU readline library, but it
  66  * was originally designed for small systems, like Atmel AVR
  67  * microcontrollers (8 bits). Indeed, we don't use any malloc that is
  68  * sometimes not implemented (or just not recommended) on such
  69  * systems.
  70  *
  71  * Obviously, it does not support as many things as the GNU readline,
  72  * but at least it supports some interesting features like a kill
  73  * buffer and a command history.
  74  *
  75  * It also have a feature that does not have the GNU readline (as far
  76  * as I know): we can have several instances of it running at the same
  77  * time, even on a monothread program, since it works with callbacks.
  78  *
  79  * The lib is designed for a client-side or a server-side use:
  80  * - server-side: the server receives all data from a socket, including
  81  *   control chars, like arrows, tabulations, ... The client is
  82  *   very simple, it can be a telnet or a minicom through a serial line.
  83  * - client-side: the client receives its data through its stdin for
  84  *   instance.
  85  */
  86
  87 #include <cmdline_cirbuf.h>
  88 #include <cmdline_vt100.h>
  89
  90 #ifdef __cplusplus
  91 extern "C" {
  92 #endif
  93
  94 /* configuration */
  95 #define RDLINE_BUF_SIZE 256
  96 #define RDLINE_PROMPT_SIZE  32
  97 #define RDLINE_VT100_BUF_SIZE  8
  98 #define RDLINE_HISTORY_BUF_SIZE BUFSIZ
  99 #define RDLINE_HISTORY_MAX_LINE 64
 100
 101 enum rdline_status {
 102         RDLINE_INIT,
 103         RDLINE_RUNNING,
 104         RDLINE_EXITED
 105 };
 106
 107 struct rdline;
 108
 109 typedef int (rdline_write_char_t)(struct rdline *rdl, char);
 110 typedef void (rdline_validate_t)(struct rdline *rdl,
 111                                  const char *buf, unsigned int size);
 112 typedef int (rdline_complete_t)(struct rdline *rdl, const char *buf,
 113                                 char *dstbuf, unsigned int dstsize,
 114                                 int *state);
 115
 116 struct rdline {
 117         enum rdline_status status;
 118         /* rdline bufs */
 119         struct cirbuf left;
 120         struct cirbuf right;
 121         char left_buf[RDLINE_BUF_SIZE+2]; /* reserve 2 chars for the \n\0 */
 122         char right_buf[RDLINE_BUF_SIZE];
 123
 124         char prompt[RDLINE_PROMPT_SIZE];
 125         unsigned int prompt_size;
 126
 127         char kill_buf[RDLINE_BUF_SIZE];
 128         unsigned int kill_size;
 129
 130         /* history */
 131         struct cirbuf history;
 132         char history_buf[RDLINE_HISTORY_BUF_SIZE];
 133         int history_cur_line;
 134
 135         /* callbacks and func pointers */
 136         rdline_write_char_t *write_char;
 137         rdline_validate_t *validate;
 138         rdline_complete_t *complete;
 139
 140         /* vt100 parser */
 141         struct cmdline_vt100 vt100;
 142
 143         /* opaque pointer */
 144         void *opaque;
 145 };
 146
 147 /**
 148  * Init fields for a struct rdline. Call this only once at the beginning
 149  * of your program.
 150  * \param rdl A pointer to an uninitialized struct rdline
 151  * \param write_char The function used by the function to write a character
 152  * \param validate A pointer to the function to execute when the
 153  *                 user validates the buffer.
 154  * \param complete A pointer to the function to execute when the
 155  *                 user completes the buffer.
 156  */
 157 int rdline_init(struct rdline *rdl,
 158                  rdline_write_char_t *write_char,
 159                  rdline_validate_t *validate,
 160                  rdline_complete_t *complete);
 161
 162
 163 /**
 164  * Init the current buffer, and display a prompt.
 165  * \param rdl A pointer to a struct rdline
 166  * \param prompt A string containing the prompt
 167  */
 168 void rdline_newline(struct rdline *rdl, const char *prompt);
 169
 170 /**
 171  * Call it and all received chars will be ignored.
 172  * \param rdl A pointer to a struct rdline
 173  */
 174 void rdline_stop(struct rdline *rdl);
 175
 176 /**
 177  * Same than rdline_stop() except that next calls to rdline_char_in()
 178  * will return RDLINE_RES_EXITED.
 179  * \param rdl A pointer to a struct rdline
 180  */
 181 void rdline_quit(struct rdline *rdl);
 182
 183 /**
 184  * Restart after a call to rdline_stop() or rdline_quit()
 185  * \param rdl A pointer to a struct rdline
 186  */
 187 void rdline_restart(struct rdline *rdl);
 188
 189 /**
 190  * Redisplay the current buffer
 191  * \param rdl A pointer to a struct rdline
 192  */
 193 void rdline_redisplay(struct rdline *rdl);
 194
 195 /**
 196  * Reset the current buffer and setup for a new line.
 197  *  \param rdl A pointer to a struct rdline
 198  */
 199 void rdline_reset(struct rdline *rdl);
 200
 201
 202 /* return status for rdline_char_in() */
 203 #define RDLINE_RES_SUCCESS       0
 204 #define RDLINE_RES_VALIDATED     1
 205 #define RDLINE_RES_COMPLETE      2
 206 #define RDLINE_RES_NOT_RUNNING  -1
 207 #define RDLINE_RES_EOF          -2
 208 #define RDLINE_RES_EXITED       -3
 209
 210 /**
 211  * append a char to the readline buffer.
 212  * Return RDLINE_RES_VALIDATE when the line has been validated.
 213  * Return RDLINE_RES_COMPLETE when the user asked to complete the buffer.
 214  * Return RDLINE_RES_NOT_RUNNING if it is not running.
 215  * Return RDLINE_RES_EOF if EOF (ctrl-d on an empty line).
 216  * Else return RDLINE_RES_SUCCESS.
 217  * XXX error case when the buffer is full ?
 218  *
 219  * \param rdl A pointer to a struct rdline
 220  * \param c The character to append
 221  */
 222 int rdline_char_in(struct rdline *rdl, char c);
 223
 224 /**
 225  * Return the current buffer, terminated by '\0'.
 226  * \param rdl A pointer to a struct rdline
 227  */
 228 const char *rdline_get_buffer(struct rdline *rdl);
 229
 230
 231 /**
 232  * Add the buffer to history.
 233  * return < 0 on error.
 234  * \param rdl A pointer to a struct rdline
 235  * \param buf A buffer that is terminated by '\0'
 236  */
 237 int rdline_add_history(struct rdline *rdl, const char *buf);
 238
 239 /**
 240  * Clear current history
 241  * \param rdl A pointer to a struct rdline
 242  */
 243 void rdline_clear_history(struct rdline *rdl);
 244
 245 /**
 246  * Get the i-th history item
 247  */
 248 char *rdline_get_history_item(struct rdline *rdl, unsigned int i);
 249
 250 #ifdef __cplusplus
 251 }
 252 #endif
 253
 254 #endif /* _RDLINE_H_ */