lib/ecoli_tk_or.c

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <assert.h>
  32 #include <stdarg.h>
  33
  34 #include <ecoli_malloc.h>
  35 #include <ecoli_log.h>
  36 #include <ecoli_strvec.h>
  37 #include <ecoli_tk.h>
  38 #include <ecoli_tk_or.h>
  39 #include <ecoli_tk_str.h>
  40 #include <ecoli_test.h>
  41
  42 struct ec_tk_or {
  43         struct ec_tk gen;
  44         struct ec_tk **table;
  45         unsigned int len;
  46 };
  47
  48 static struct ec_parsed_tk *ec_tk_or_parse(const struct ec_tk *gen_tk,
  49         const struct ec_strvec *strvec)
  50 {
  51         struct ec_tk_or *tk = (struct ec_tk_or *)gen_tk;
  52         struct ec_parsed_tk *parsed_tk, *child_parsed_tk = NULL;
  53         struct ec_strvec *match_strvec;
  54         unsigned int i;
  55
  56         parsed_tk = ec_parsed_tk_new();
  57         if (parsed_tk == NULL)
  58                 goto fail;
  59
  60         for (i = 0; i < tk->len; i++) {
  61                 child_parsed_tk = ec_tk_parse_tokens(tk->table[i], strvec);
  62                 if (child_parsed_tk == NULL)
  63                         goto fail;
  64                 if (ec_parsed_tk_matches(child_parsed_tk))
  65                         break;
  66                 ec_parsed_tk_free(child_parsed_tk);
  67                 child_parsed_tk = NULL;
  68         }
  69
  70         /* no match */
  71         if (i == tk->len)
  72                 return parsed_tk;
  73
  74         match_strvec = ec_strvec_dup(child_parsed_tk->strvec);
  75         if (match_strvec == NULL)
  76                 goto fail;
  77
  78         ec_parsed_tk_set_match(parsed_tk, gen_tk, match_strvec);
  79         ec_parsed_tk_add_child(parsed_tk, child_parsed_tk);
  80
  81         return parsed_tk;
  82
  83  fail:
  84         ec_parsed_tk_free(child_parsed_tk);
  85         ec_parsed_tk_free(parsed_tk);
  86         return NULL;
  87 }
  88
  89 static struct ec_completed_tk *ec_tk_or_complete(const struct ec_tk *gen_tk,
  90         const struct ec_strvec *strvec)
  91 {
  92         struct ec_tk_or *tk = (struct ec_tk_or *)gen_tk;
  93         struct ec_completed_tk *completed_tk, *child_completed_tk;
  94         size_t n;
  95
  96         completed_tk = ec_completed_tk_new();
  97         if (completed_tk == NULL)
  98                 return NULL;
  99
 100         for (n = 0; n < tk->len; n++) {
 101                 child_completed_tk = ec_tk_complete_tokens(tk->table[n],
 102                         strvec);
 103
 104                 if (child_completed_tk == NULL) // XXX fail instead?
 105                         continue;
 106
 107                 ec_completed_tk_merge(completed_tk, child_completed_tk);
 108         }
 109
 110         return completed_tk;
 111 }
 112
 113 static void ec_tk_or_free_priv(struct ec_tk *gen_tk)
 114 {
 115         struct ec_tk_or *tk = (struct ec_tk_or *)gen_tk;
 116         unsigned int i;
 117
 118         for (i = 0; i < tk->len; i++)
 119                 ec_tk_free(tk->table[i]);
 120         ec_free(tk->table);
 121 }
 122
 123 static struct ec_tk_ops ec_tk_or_ops = {
 124         .typename = "or",
 125         .parse = ec_tk_or_parse,
 126         .complete = ec_tk_or_complete,
 127         .free_priv = ec_tk_or_free_priv,
 128 };
 129
 130 struct ec_tk *ec_tk_or_new(const char *id)
 131 {
 132         struct ec_tk_or *tk = NULL;
 133
 134         tk = (struct ec_tk_or *)ec_tk_new(id, &ec_tk_or_ops, sizeof(*tk));
 135         if (tk == NULL)
 136                 return NULL;
 137
 138         tk->table = NULL;
 139         tk->len = 0;
 140
 141         return &tk->gen;
 142 }
 143
 144 struct ec_tk *ec_tk_or_new_list(const char *id, ...)
 145 {
 146         struct ec_tk_or *tk = NULL;
 147         struct ec_tk *child;
 148         va_list ap;
 149         int fail = 0;
 150
 151         va_start(ap, id);
 152
 153         tk = (struct ec_tk_or *)ec_tk_or_new(id);
 154         if (tk == NULL)
 155                 goto fail;
 156
 157         for (child = va_arg(ap, struct ec_tk *);
 158              child != EC_TK_ENDLIST;
 159              child = va_arg(ap, struct ec_tk *)) {
 160                 /* on error, don't quit the loop to avoid leaks */
 161
 162                 if (child == NULL || ec_tk_or_add(&tk->gen, child) < 0)
 163                         fail = 1;
 164         }
 165
 166         if (fail == 1)
 167                 goto fail;
 168
 169         va_end(ap);
 170         return &tk->gen;
 171
 172 fail:
 173         ec_tk_free(&tk->gen); /* will also free children */
 174         va_end(ap);
 175         return NULL;
 176 }
 177
 178 int ec_tk_or_add(struct ec_tk *gen_tk, struct ec_tk *child)
 179 {
 180         struct ec_tk_or *tk = (struct ec_tk_or *)gen_tk;
 181         struct ec_tk **table;
 182
 183         assert(tk != NULL);
 184         assert(child != NULL);
 185
 186         table = ec_realloc(tk->table, (tk->len + 1) * sizeof(*tk->table));
 187         if (table == NULL)
 188                 return -1;
 189
 190         tk->table = table;
 191         table[tk->len] = child;
 192         tk->len ++;
 193
 194         return 0;
 195 }
 196
 197 static int ec_tk_or_testcase(void)
 198 {
 199         struct ec_tk *tk;
 200         int ret = 0;
 201
 202         tk = ec_tk_or_new_list(NULL,
 203                 ec_tk_str_new(NULL, "foo"),
 204                 ec_tk_str_new(NULL, "bar"),
 205                 EC_TK_ENDLIST);
 206         if (tk == NULL) {
 207                 ec_log(EC_LOG_ERR, "cannot create tk\n");
 208                 return -1;
 209         }
 210         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "foo", EC_TK_ENDLIST);
 211         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "bar", EC_TK_ENDLIST);
 212         ret |= EC_TEST_CHECK_TK_PARSE(tk, 1, "foo", "bar", EC_TK_ENDLIST);
 213         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, " ", EC_TK_ENDLIST);
 214         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "foox", EC_TK_ENDLIST);
 215         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "toto", EC_TK_ENDLIST);
 216         ret |= EC_TEST_CHECK_TK_PARSE(tk, -1, "", EC_TK_ENDLIST);
 217         ec_tk_free(tk);
 218
 219         /* test completion */
 220         tk = ec_tk_or_new_list(NULL,
 221                 ec_tk_str_new(NULL, "foo"),
 222                 ec_tk_str_new(NULL, "bar"),
 223                 ec_tk_str_new(NULL, "bar2"),
 224                 ec_tk_str_new(NULL, "toto"),
 225                 ec_tk_str_new(NULL, "titi"),
 226                 EC_TK_ENDLIST);
 227         if (tk == NULL) {
 228                 ec_log(EC_LOG_ERR, "cannot create tk\n");
 229                 return -1;
 230         }
 231         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 232                 "", EC_TK_ENDLIST,
 233                 "foo", "bar", "bar2", "toto", "titi", EC_TK_ENDLIST,
 234                 "");
 235         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 236                 "f", EC_TK_ENDLIST,
 237                 "oo", EC_TK_ENDLIST,
 238                 "oo");
 239         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 240                 "b", EC_TK_ENDLIST,
 241                 "ar", "ar2", EC_TK_ENDLIST,
 242                 "ar");
 243         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 244                 "bar", EC_TK_ENDLIST,
 245                 "", "2", EC_TK_ENDLIST,
 246                 "");
 247         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 248                 "t", EC_TK_ENDLIST,
 249                 "oto", "iti", EC_TK_ENDLIST,
 250                 "");
 251         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 252                 "to", EC_TK_ENDLIST,
 253                 "to", EC_TK_ENDLIST,
 254                 "to");
 255         ret |= EC_TEST_CHECK_TK_COMPLETE(tk,
 256                 "x", EC_TK_ENDLIST,
 257                 EC_TK_ENDLIST,
 258                 "");
 259         ec_tk_free(tk);
 260
 261         return ret;
 262 }
 263
 264 static struct ec_test ec_tk_or_test = {
 265         .name = "tk_or",
 266         .test = ec_tk_or_testcase,
 267 };
 268
 269 EC_REGISTER_TEST(ec_tk_or_test);