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_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, buf);
  83         if (ret == CMDLINE_PARSE_AMBIGUOUS)
  84                 cmdline_printf(cl, "Ambiguous command\n");
  85         else if (ret == CMDLINE_PARSE_NOMATCH)
  86                 cmdline_printf(cl, "Command not found\n");
  87         else if (ret == CMDLINE_PARSE_BAD_ARGS)
  88                 cmdline_printf(cl, "Bad arguments\n");
  89         else if (ret == CMDLINE_PARSE_UNTERMINATED_QUOTE)
  90                 cmdline_printf(cl, "Unterminated quote\n");
  91 }
  92
  93 static int
  94 cmdline_complete_buffer(struct rdline *rdl, const char *buf,
  95                         char *dstbuf, unsigned int dstsize,
  96                         int *state)
  97 {
  98         struct cmdline *cl = rdl->opaque;
  99         return cmdline_complete(cl, buf, state, dstbuf, dstsize);
 100 }
 101
 102 int
 103 cmdline_write_char(struct rdline *rdl, char c)
 104 {
 105         int ret = -1;
 106         struct cmdline *cl = rdl->opaque;
 107
 108         if (cl->s_out >= 0)
 109                 ret = write(cl->s_out, &c, 1);
 110
 111         return ret;
 112 }
 113
 114
 115 void
 116 cmdline_set_prompt(struct cmdline *cl, const char *prompt)
 117 {
 118         snprintf(cl->prompt, sizeof(cl->prompt), "%s", prompt);
 119 }
 120
 121 struct cmdline *
 122 cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out)
 123 {
 124         struct cmdline *cl;
 125         cl = malloc(sizeof(struct cmdline));
 126         if (cl == NULL)
 127                 return NULL;
 128         memset(cl, 0, sizeof(struct cmdline));
 129         cl->s_in = s_in;
 130         cl->s_out = s_out;
 131         cl->ctx = ctx;
 132
 133         rdline_init(&cl->rdl, cmdline_write_char,
 134                     cmdline_valid_buffer, cmdline_complete_buffer);
 135         cl->rdl.opaque = cl;
 136         cmdline_set_prompt(cl, prompt);
 137         rdline_newline(&cl->rdl, cl->prompt);
 138
 139         return cl;
 140 }
 141
 142 void
 143 cmdline_free(struct cmdline *cl)
 144 {
 145         dprintf("called\n");
 146         if (cl->s_in > 2)
 147                 close(cl->s_in);
 148         if (cl->s_out != cl->s_in && cl->s_out > 2)
 149                 close(cl->s_out);
 150         free(cl);
 151 }
 152
 153 void
 154 cmdline_printf(const struct cmdline *cl, const char *fmt, ...)
 155 {
 156         va_list ap;
 157
 158 #ifdef _GNU_SOURCE
 159         if (cl->s_out < 0)
 160                 return;
 161         va_start(ap, fmt);
 162         vdprintf(cl->s_out, fmt, ap);
 163         va_end(ap);
 164 #else
 165         int ret;
 166         char *buf;
 167
 168         if (cl->s_out < 0)
 169                 return;
 170
 171         buf = malloc(BUFSIZ);
 172         if (buf == NULL)
 173                 return;
 174         va_start(ap, fmt);
 175         ret = vsnprintf(buf, BUFSIZ, fmt, ap);
 176         va_end(ap);
 177         if (ret < 0)
 178                 return;
 179         if (ret >= BUFSIZ)
 180                 ret = BUFSIZ - 1;
 181         write(cl->s_out, buf, ret);
 182         free(buf);
 183 #endif
 184 }
 185
 186 int
 187 cmdline_in(struct cmdline *cl, const char *buf, int size)
 188 {
 189         const char *history, *buffer;
 190         int ret = 0;
 191         int i, same;
 192
 193         for (i=0; i<size; i++) {
 194                 ret = rdline_char_in(&cl->rdl, buf[i]);
 195
 196                 if (ret == RDLINE_RES_VALIDATED) {
 197                         buffer = rdline_get_buffer(&cl->rdl);
 198                         history = rdline_get_history_item(&cl->rdl, 0);
 199                         if (history) {
 200                                 same = !memcmp(buffer, history, strlen(history)) &&
 201                                         buffer[strlen(history)] == '\n';
 202                         }
 203                         else
 204                                 same = 0;
 205                         if (strlen(buffer) > 1 && !same)
 206                                 rdline_add_history(&cl->rdl, buffer);
 207                         rdline_newline(&cl->rdl, cl->prompt);
 208                 }
 209                 else if (ret == RDLINE_RES_EOF)
 210                         return -1;
 211                 else if (ret == RDLINE_RES_EXITED)
 212                         return -1;
 213         }
 214         return i;
 215 }
 216
 217 void
 218 cmdline_quit(struct cmdline *cl)
 219 {
 220         rdline_quit(&cl->rdl);
 221 }
 222
 223 void
 224 cmdline_interact(struct cmdline *cl)
 225 {
 226         char c;
 227
 228         c = -1;
 229         while (1) {
 230                 if (read(cl->s_in, &c, 1) < 0)
 231                         break;
 232                 if (cmdline_in(cl, &c, 1) < 0)
 233                         break;
 234         }
 235 }