src/lib/cmdline.c

   1 /*-
   2  * Copyright (c) <2010>, Intel Corporation
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  *
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  *
  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
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  32  * OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 /*
  36  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  37  * All rights reserved.
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions are met:
  40  *
  41  *     * Redistributions of source code must retain the above copyright
  42  *       notice, this list of conditions and the following disclaimer.
  43  *     * Redistributions in binary form must reproduce the above copyright
  44  *       notice, this list of conditions and the following disclaimer in the
  45  *       documentation and/or other materials provided with the distribution.
  46  *     * Neither the name of the University of California, Berkeley nor the
  47  *       names of its contributors may be used to endorse or promote products
  48  *       derived from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  51  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  52  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  53  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  54  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  55  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  56  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  57  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  59  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  */
  61
  62 #include <stdio.h>
  63 #include <string.h>
  64 #include <unistd.h>
  65 #include <stdlib.h>
  66 #include <stdarg.h>
  67 #include <inttypes.h>
  68 #include <fcntl.h>
  69 #include <termios.h>
  70 #include <netinet/in.h>
  71
  72 #include "cmdline_parse.h"
  73 #include "cmdline_rdline.h"
  74 #include "cmdline.h"
  75
  76 static void
  77 cmdline_default_valid_buffer(struct rdline *rdl, const char *buf,
  78                              __attribute__((unused)) unsigned int size)
  79 {
  80         struct cmdline *cl = rdl->opaque;
  81         int ret;
  82         ret = cmdline_parse(cl->ctx, buf, cl);
  83         if (ret == CMDLINE_PARSE_AMBIGUOUS)
  84                 cmdline_printf(cl, "Ambiguous command\n");
  85         else if (ret == CMDLINE_PARSE_NOMATCH)
  86                 cmdline_printf(cl, "Bad arguments\n");
  87         else if (ret == CMDLINE_PARSE_UNTERMINATED_QUOTE)
  88                 cmdline_printf(cl, "Unterminated quote\n");
  89 }
  90
  91 static int
  92 cmdline_default_complete_buffer(struct rdline *rdl, const char *buf,
  93                                 char *dstbuf, unsigned int dstsize)
  94 {
  95         struct cmdline *cl = rdl->opaque;
  96         // RDLINE_RES_COMPLETE ?
  97         return cmdline_complete(cl->ctx, buf, dstbuf, dstsize);
  98 }
  99
 100
 101 static int
 102 cmdline_default_help(struct rdline *rdl, const char *buf,
 103                      rdline_write_t *write_cb, void *write_arg)
 104 {
 105         struct cmdline *cl = rdl->opaque;
 106         return cmdline_help(cl->ctx, buf, cmdline_write, write_arg);
 107 }
 108
 109 /* ---- Some rdline wrappers ---- */
 110
 111 /* write a buffer, just use rdline */
 112 ssize_t
 113 cmdline_write(void *arg, void *buf, size_t count)
 114 {
 115         const struct rdline *rdl = arg;
 116         return rdline_write(rdl, buf, count);
 117 }
 118
 119 void
 120 cmdline_set_prompt(struct cmdline *cl, const char *prompt)
 121 {
 122         snprintf(cl->prompt, sizeof(cl->prompt), "%s", prompt);
 123 }
 124
 125 struct cmdline *
 126 cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out)
 127 {
 128         struct cmdline *cl;
 129
 130         cl = malloc(sizeof(struct cmdline));
 131         if (cl == NULL)
 132                 return NULL;
 133
 134         /* init cmdline structure */
 135         memset(cl, 0, sizeof(struct cmdline));
 136         cl->s_in = s_in;
 137         cl->s_out = s_out;
 138         cl->ctx = ctx;
 139
 140         /* init embedded rdline */
 141         rdline_init(&cl->rdl, s_in, s_out,
 142                     cmdline_default_valid_buffer,
 143                     cmdline_default_complete_buffer,
 144                     cmdline_default_help);
 145
 146         cl->rdl.opaque = cl;
 147         cmdline_set_prompt(cl, prompt);
 148         rdline_newline(&cl->rdl, cl->prompt);
 149
 150         return cl;
 151 }
 152
 153 void
 154 cmdline_free(struct cmdline *cl)
 155 {
 156         dprintf("called\n");
 157         if (cl->s_in > 2)
 158                 close(cl->s_in);
 159         if (cl->s_out != cl->s_in && cl->s_out > 2)
 160                 close(cl->s_out);
 161         free(cl);
 162 }
 163
 164 int
 165 cmdline_printf(const struct cmdline *cl, const char *fmt, ...)
 166 {
 167         va_list ap;
 168         int ret;
 169
 170         va_start(ap, fmt);
 171         ret = rdline_vprintf(&cl->rdl, fmt, ap);
 172         va_end(ap);
 173
 174         return ret;
 175 }
 176
 177 /* Push an input buffer in the command line. Typically, this function
 178  * is called by cmdline_interact() to send the input characters to the
 179  * cmdline process. It can also be called by a user callback function,
 180  * when a buffer is received from the input socket.
 181  *
 182  * The function returns the number of processed characters, or a
 183  * negative value on error (EOF reached or command line exited. */
 184 int
 185 cmdline_in(struct cmdline *cl, const char *buf, int size)
 186 {
 187         int ret = 0;
 188         int i;
 189
 190         for (i = 0; i < size; i++) {
 191                 ret = rdline_char_in(&cl->rdl, buf[i]);
 192
 193                 if (ret == RDLINE_RES_VALIDATED)
 194                         rdline_newline(&cl->rdl, cl->prompt);
 195                 else if (ret == RDLINE_RES_EOF)
 196                         return -1;
 197                 else if (ret == RDLINE_RES_EXITED)
 198                         return -1;
 199         }
 200         return i;
 201 }
 202
 203 /* Interrupt a running command line process */
 204 void
 205 cmdline_quit(struct cmdline *cl)
 206 {
 207         rdline_quit(&cl->rdl);
 208 }
 209
 210 /* Start command line on configured file descriptor. This function
 211  * loops until the user explicitelly call cmdline_quit(), or if the
 212  * input fd reaches EOF. */
 213 void
 214 cmdline_interact(struct cmdline *cl)
 215 {
 216         char c;
 217
 218         c = -1;
 219         while (1) {
 220                 if (read(cl->s_in, &c, 1) < 0)
 221                         break;
 222                 if (cmdline_in(cl, &c, 1) < 0)
 223                         break;
 224         }
 225 }