lib/ecoli_completed.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 <errno.h>
  33
  34 #include <ecoli_malloc.h>
  35 #include <ecoli_strvec.h>
  36 #include <ecoli_keyval.h>
  37 #include <ecoli_log.h>
  38 #include <ecoli_node.h>
  39 #include <ecoli_parsed.h>
  40 #include <ecoli_completed.h>
  41
  42 struct ec_completed *ec_completed(void)
  43 {
  44         struct ec_completed *completed = NULL;
  45
  46         completed = ec_calloc(1, sizeof(*completed));
  47         if (completed == NULL)
  48                 return NULL;
  49
  50         TAILQ_INIT(&completed->elts);
  51         completed->count_match = 0;
  52
  53         return completed;
  54 }
  55
  56 struct ec_completed_elt *ec_completed_elt(const struct ec_node *node,
  57         const char *add)
  58 {
  59         struct ec_completed_elt *elt = NULL;
  60
  61         elt = ec_calloc(1, sizeof(*elt));
  62         if (elt == NULL)
  63                 return NULL;
  64
  65         elt->node = node;
  66         if (add != NULL) {
  67                 elt->add = ec_strdup(add);
  68                 if (elt->add == NULL) {
  69                         ec_completed_elt_free(elt);
  70                         return NULL;
  71                 }
  72         }
  73
  74         return elt;
  75 }
  76
  77 /* XXX define when to use ec_node_complete() or node->complete()
  78  * (same for parse)
  79  * suggestion: node->op() is internal, user calls the function
  80  * other idea: have 2 functions
  81  */
  82 struct ec_completed *ec_node_complete(struct ec_node *node,
  83         const char *str)
  84 {
  85         struct ec_strvec *strvec = NULL;
  86         struct ec_completed *completed;
  87
  88         errno = ENOMEM;
  89         strvec = ec_strvec();
  90         if (strvec == NULL)
  91                 goto fail;
  92
  93         if (ec_strvec_add(strvec, str) < 0)
  94                 goto fail;
  95
  96         completed = ec_node_complete_strvec(node, strvec);
  97         if (completed == NULL)
  98                 goto fail;
  99
 100         ec_strvec_free(strvec);
 101         return completed;
 102
 103  fail:
 104         ec_strvec_free(strvec);
 105         return NULL;
 106 }
 107
 108 /* default completion function: return a no-match element */
 109 struct ec_completed *ec_node_default_complete(const struct ec_node *gen_node,
 110         const struct ec_strvec *strvec)
 111 {
 112         struct ec_completed *completed;
 113         struct ec_completed_elt *completed_elt;
 114
 115         (void)strvec;
 116
 117         completed = ec_completed();
 118         if (completed == NULL)
 119                 return NULL;
 120
 121         if (ec_strvec_len(strvec) != 1)
 122                 return completed;
 123
 124         completed_elt = ec_completed_elt(gen_node, NULL);
 125         if (completed_elt == NULL) {
 126                 ec_completed_free(completed);
 127                 return NULL;
 128         }
 129
 130         ec_completed_add_elt(completed, completed_elt);
 131
 132         return completed;
 133 }
 134
 135 struct ec_completed *ec_node_complete_strvec(struct ec_node *node,
 136         const struct ec_strvec *strvec)
 137 {
 138         int ret;
 139
 140         /* build the node if required */
 141         if (node->type->build != NULL) {
 142                 if ((node->flags & EC_NODE_F_BUILT) == 0) {
 143                         ret = node->type->build(node);
 144                         if (ret < 0) {
 145                                 errno = -ret;
 146                                 return NULL;
 147                         }
 148                 }
 149         }
 150         node->flags |= EC_NODE_F_BUILT;
 151
 152         if (node->type->complete == NULL) {
 153                 errno = ENOTSUP;
 154                 return NULL;
 155         }
 156
 157         return node->type->complete(node, strvec);
 158 }
 159
 160 /* count the number of identical chars at the beginning of 2 strings */
 161 static size_t strcmp_count(const char *s1, const char *s2)
 162 {
 163         size_t i = 0;
 164
 165         while (s1[i] && s2[i] && s1[i] == s2[i])
 166                 i++;
 167
 168         return i;
 169 }
 170
 171 void ec_completed_add_elt(
 172         struct ec_completed *completed, struct ec_completed_elt *elt)
 173 {
 174         size_t n;
 175
 176         TAILQ_INSERT_TAIL(&completed->elts, elt, next);
 177         completed->count++;
 178         if (elt->add != NULL) {
 179                 completed->count_match++;
 180                 if (completed->smallest_start == NULL) {
 181                         completed->smallest_start = ec_strdup(elt->add);
 182                 } else {
 183                         n = strcmp_count(elt->add,
 184                                 completed->smallest_start);
 185                         completed->smallest_start[n] = '\0';
 186                 }
 187         }
 188 }
 189
 190 void ec_completed_elt_free(struct ec_completed_elt *elt)
 191 {
 192         ec_free(elt->add);
 193         ec_free(elt);
 194 }
 195
 196 void ec_completed_merge(struct ec_completed *completed1,
 197         struct ec_completed *completed2)
 198 {
 199         struct ec_completed_elt *elt;
 200
 201         assert(completed1 != NULL);
 202         assert(completed2 != NULL);
 203
 204         while (!TAILQ_EMPTY(&completed2->elts)) {
 205                 elt = TAILQ_FIRST(&completed2->elts);
 206                 TAILQ_REMOVE(&completed2->elts, elt, next);
 207                 ec_completed_add_elt(completed1, elt);
 208         }
 209
 210         ec_completed_free(completed2);
 211 }
 212
 213 void ec_completed_free(struct ec_completed *completed)
 214 {
 215         struct ec_completed_elt *elt;
 216
 217         if (completed == NULL)
 218                 return;
 219
 220         while (!TAILQ_EMPTY(&completed->elts)) {
 221                 elt = TAILQ_FIRST(&completed->elts);
 222                 TAILQ_REMOVE(&completed->elts, elt, next);
 223                 ec_completed_elt_free(elt);
 224         }
 225         ec_free(completed->smallest_start);
 226         ec_free(completed);
 227 }
 228
 229 void ec_completed_dump(FILE *out, const struct ec_completed *completed)
 230 {
 231         struct ec_completed_elt *elt;
 232
 233         if (completed == NULL || completed->count == 0) {
 234                 fprintf(out, "no completion\n");
 235                 return;
 236         }
 237
 238         fprintf(out, "completion: count=%u match=%u smallest_start=<%s>\n",
 239                 completed->count, completed->count_match,
 240                 completed->smallest_start);
 241
 242         TAILQ_FOREACH(elt, &completed->elts, next) {
 243                 fprintf(out, "add=<%s>, node=%p, node_type=%s\n",
 244                         elt->add, elt->node, elt->node->type->name);
 245         }
 246 }
 247
 248 const char *ec_completed_smallest_start(
 249         const struct ec_completed *completed)
 250 {
 251         if (completed == NULL || completed->smallest_start == NULL)
 252                 return "";
 253
 254         return completed->smallest_start;
 255 }
 256
 257 unsigned int ec_completed_count(
 258         const struct ec_completed *completed,
 259         enum ec_completed_filter_flags flags)
 260 {
 261         unsigned int count = 0;
 262
 263         if (completed == NULL)
 264                 return count;
 265
 266         if (flags & EC_MATCH)
 267                 count += completed->count_match;
 268         if (flags & EC_NO_MATCH)
 269                 count += (completed->count - completed->count_match); //XXX
 270
 271         return count;
 272 }
 273
 274 struct ec_completed_iter *
 275 ec_completed_iter(struct ec_completed *completed,
 276         enum ec_completed_filter_flags flags)
 277 {
 278         struct ec_completed_iter *iter;
 279
 280         iter = ec_calloc(1, sizeof(*iter));
 281         if (iter == NULL)
 282                 return NULL;
 283
 284         iter->completed = completed;
 285         iter->flags = flags;
 286         iter->cur = NULL;
 287
 288         return iter;
 289 }
 290
 291 const struct ec_completed_elt *ec_completed_iter_next(
 292         struct ec_completed_iter *iter)
 293 {
 294         if (iter->completed == NULL)
 295                 return NULL;
 296
 297         do {
 298                 if (iter->cur == NULL) {
 299                         iter->cur = TAILQ_FIRST(&iter->completed->elts);
 300                 } else {
 301                         iter->cur = TAILQ_NEXT(iter->cur, next);
 302                 }
 303
 304                 if (iter->cur == NULL)
 305                         break;
 306
 307                 if (iter->cur->add == NULL &&
 308                                 (iter->flags & EC_NO_MATCH))
 309                         break;
 310
 311                 if (iter->cur->add != NULL &&
 312                                 (iter->flags & EC_MATCH))
 313                         break;
 314
 315         } while (iter->cur != NULL);
 316
 317         return iter->cur;
 318 }
 319
 320 void ec_completed_iter_free(struct ec_completed_iter *iter)
 321 {
 322         ec_free(iter);
 323 }