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
  71 #include <netinet/in.h>
  72
  73 #include "cmdline_parse.h"
  74 #include "cmdline_rdline.h"
  75 #include "cmdline.h"
  76
  77
  78 #define PROMPT_SUFFIX "> "
  79
  80
  81 /**********************/
  82
  83 static void
  84 cmdline_valid_buffer(struct rdline *rdl, const char *buf,
  85                      __attribute__((unused)) unsigned int size)
  86 {
  87         struct cmdline *cl = rdl->opaque;
  88         int ret;
  89         ret = cmdline_parse(cl, buf);
  90         if (ret == CMDLINE_PARSE_AMBIGUOUS)
  91                 cmdline_printf(cl, "Ambiguous command\n");
  92         else if (ret == CMDLINE_PARSE_NOMATCH)
  93                 cmdline_printf(cl, "Command not found\n");
  94         else if (ret == CMDLINE_PARSE_BAD_ARGS)
  95                 cmdline_printf(cl, "Bad arguments\n");
  96 }
  97
  98 static int
  99 cmdline_complete_buffer(struct rdline *rdl, const char *buf,
 100                         char *dstbuf, unsigned int dstsize,
 101                         int *state)
 102 {
 103         struct cmdline *cl = rdl->opaque;
 104         return cmdline_complete(cl, buf, state, dstbuf, dstsize);
 105 }
 106
 107 void
 108 cmdline_write_char(struct rdline *rdl, char c)
 109 {
 110         struct cmdline *cl = rdl->opaque;
 111         if (cl->s_out >= 0) {
 112                 write(cl->s_out, &c, 1);
 113         }
 114 }
 115
 116
 117 void
 118 cmdline_set_prompt(struct cmdline *cl, const char *prompt)
 119 {
 120         snprintf(cl->prompt, sizeof(cl->prompt), prompt);
 121 }
 122
 123 struct cmdline *
 124 cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out)
 125 {
 126         struct cmdline *cl;
 127         cl = malloc(sizeof(struct cmdline));
 128         if (cl == NULL)
 129                 return NULL;
 130         memset(cl, 0, sizeof(struct cmdline));
 131         cl->s_in = s_in;
 132         cl->s_out = s_out;
 133         cl->ctx = ctx;
 134
 135         rdline_init(&cl->rdl, cmdline_write_char,
 136                     cmdline_valid_buffer, cmdline_complete_buffer);
 137         cl->rdl.opaque = cl;
 138         cmdline_set_prompt(cl, prompt);
 139         rdline_newline(&cl->rdl, cl->prompt);
 140
 141         return cl;
 142 }
 143
 144 void
 145 cmdline_free(struct cmdline *cl)
 146 {
 147         dprintf("called\n");
 148         if (cl->s_in > 2)
 149                 close(cl->s_in);
 150         if (cl->s_out != cl->s_in && cl->s_out > 2)
 151                 close(cl->s_out);
 152         free(cl);
 153 }
 154
 155 void
 156 cmdline_printf(const struct cmdline *cl, const char *fmt, ...)
 157 {
 158         va_list ap;
 159         char buffer[BUFSIZ];
 160
 161         va_start(ap, fmt);
 162         vsnprintf(buffer, 512, fmt, ap);
 163         va_end(ap);
 164         if (cl->s_out >= 0) {
 165                 write(cl->s_out, buffer, strlen(buffer));
 166         }
 167 }
 168
 169 int
 170 cmdline_in(struct cmdline *cl, const char *buf, int size)
 171 {
 172         const char *history, *buffer;
 173         int ret = 0;
 174         int i, same;
 175
 176         /* XXX use defines instead of hardcoded values */
 177         for (i=0; i<size; i++) {
 178                 ret = rdline_char_in(&cl->rdl, buf[i]);
 179
 180                 if (ret == 1) {
 181                         buffer = rdline_get_buffer(&cl->rdl);
 182                         history = rdline_get_history_item(&cl->rdl, 0);
 183                         if (history) {
 184                                 same = !memcmp(buffer, history, strlen(history)) &&
 185                                         buffer[strlen(history)] == '\n';
 186                         }
 187                         else
 188                                 same = 0;
 189                         if (strlen(buffer) > 1 && !same)
 190                                 rdline_add_history(&cl->rdl, buffer);
 191                         rdline_newline(&cl->rdl, cl->prompt);
 192                 }
 193                 else if (ret == -2)
 194                         return -1;
 195         }
 196         return i;
 197 }
 198
 199 void
 200 cmdline_interact(struct cmdline *cl)
 201 {
 202         char c;
 203
 204         c = -1;
 205         while (1) {
 206                 read(cl->s_in, &c, 1);
 207                 if (cmdline_in(cl, &c, 1) < 0) {
 208                         break;
 209                 }
 210         }
 211         cmdline_free(cl);
 212 }