save state in completed objects
[protos/libecoli.git] / lib / ecoli_node_sh_lex.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 #include <ctype.h>
34 #include <errno.h>
35
36 #include <ecoli_malloc.h>
37 #include <ecoli_log.h>
38 #include <ecoli_test.h>
39 #include <ecoli_strvec.h>
40 #include <ecoli_node.h>
41 #include <ecoli_parsed.h>
42 #include <ecoli_completed.h>
43 #include <ecoli_node_seq.h>
44 #include <ecoli_node_str.h>
45 #include <ecoli_node_option.h>
46 #include <ecoli_node_sh_lex.h>
47
48 EC_LOG_TYPE_REGISTER(node_sh_lex);
49
50 struct ec_node_sh_lex {
51         struct ec_node gen;
52         struct ec_node *child;
53 };
54
55 static size_t eat_spaces(const char *str)
56 {
57         size_t i = 0;
58
59         /* skip spaces */
60         while (isblank(str[i]))
61                 i++;
62
63         return i;
64 }
65
66 /*
67  * Allocate a new string which is a copy of the input string with quotes
68  * removed. If quotes are not closed properly, set missing_quote to the
69  * missing quote char.
70  */
71 static char *unquote_str(const char *str, size_t n, int allow_missing_quote,
72         char *missing_quote)
73 {
74         unsigned s = 1, d = 0;
75         char quote = str[0];
76         char *dst;
77         int closed = 0;
78
79         dst = ec_malloc(n);
80         if (dst == NULL) {
81                 errno = ENOMEM;
82                 return NULL;
83         }
84
85         /* copy string and remove quotes */
86         while (s < n && d < n && str[s] != '\0') {
87                 if (str[s] == '\\' && str[s+1] == quote) {
88                         dst[d++] = quote;
89                         s += 2;
90                         continue;
91                 }
92                 if (str[s] == '\\' && str[s+1] == '\\') {
93                         dst[d++] = '\\';
94                         s += 2;
95                         continue;
96                 }
97                 if (str[s] == quote) {
98                         s++;
99                         closed = 1;
100                         break;
101                 }
102                 dst[d++] = str[s++];
103         }
104
105         /* not enough room in dst buffer (should not happen) */
106         if (d >= n) {
107                 ec_free(dst);
108                 errno = EMSGSIZE;
109                 return NULL;
110         }
111
112         /* quote not closed */
113         if (closed == 0) {
114                 if (missing_quote != NULL)
115                         *missing_quote = str[0];
116                 if (allow_missing_quote == 0) {
117                         ec_free(dst);
118                         errno = EINVAL;
119                         return NULL;
120                 }
121         }
122         dst[d++] = '\0';
123
124         return dst;
125 }
126
127 static size_t eat_quoted_str(const char *str)
128 {
129         size_t i = 0;
130         char quote = str[0];
131
132         while (str[i] != '\0') {
133                 if (str[i] != '\\' && str[i+1] == quote)
134                         return i + 2;
135                 i++;
136         }
137
138         /* unclosed quote, will be detected later */
139         return i;
140 }
141
142 static size_t eat_str(const char *str)
143 {
144         size_t i = 0;
145
146         /* eat chars until we find a quote, space, or end of string  */
147         while (!isblank(str[i]) && str[i] != '\0' &&
148                         str[i] != '"' && str[i] != '\'')
149                 i++;
150
151         return i;
152 }
153
154 static struct ec_strvec *tokenize(const char *str, int completion,
155         int allow_missing_quote, char *missing_quote)
156 {
157         struct ec_strvec *strvec = NULL;
158         size_t off = 0, len, suboff, sublen;
159         char *word = NULL, *concat = NULL, *tmp;
160         int last_is_space = 1;
161
162         strvec = ec_strvec();
163         if (strvec == NULL)
164                 goto fail;
165
166         while (str[off] != '\0') {
167                 len = eat_spaces(&str[off]);
168                 if (len > 0)
169                         last_is_space = 1;
170                 off += len;
171
172                 len = 0;
173                 suboff = off;
174                 while (str[suboff] != '\0') {
175                         last_is_space = 0;
176                         if (str[suboff] == '"' || str[suboff] == '\'') {
177                                 sublen = eat_quoted_str(&str[suboff]);
178                                 word = unquote_str(&str[suboff], sublen,
179                                         allow_missing_quote, missing_quote);
180                         } else {
181                                 sublen = eat_str(&str[suboff]);
182                                 if (sublen == 0)
183                                         break;
184                                 word = ec_strndup(&str[suboff], sublen);
185                         }
186
187                         if (word == NULL)
188                                 goto fail;
189
190                         len += sublen;
191                         suboff += sublen;
192
193                         if (concat == NULL) {
194                                 concat = word;
195                                 word = NULL;
196                         } else {
197                                 tmp = ec_realloc(concat, len + 1);
198                                 if (tmp == NULL)
199                                         goto fail;
200                                 concat = tmp;
201                                 strcat(concat, word);
202                                 ec_free(word);
203                                 word = NULL;
204                         }
205                 }
206
207                 if (concat != NULL) {
208                         if (ec_strvec_add(strvec, concat) < 0)
209                                 goto fail;
210                         ec_free(concat);
211                         concat = NULL;
212                 }
213
214                 /* XXX remove all printf comments */
215 //              printf("str off=%zd len=%zd\n", off, len);
216                 off += len;
217         }
218
219         /* in completion mode, append an empty string in the vector if
220          * the input string ends with space */
221         if (completion && last_is_space) {
222                 if (ec_strvec_add(strvec, "") < 0)
223                         goto fail;
224         }
225
226         return strvec;
227
228  fail:
229         ec_free(word);
230         ec_free(concat);
231         ec_strvec_free(strvec);
232         return NULL;
233 }
234
235 static int
236 ec_node_sh_lex_parse(const struct ec_node *gen_node,
237                 struct ec_parsed *state,
238                 const struct ec_strvec *strvec)
239 {
240         struct ec_node_sh_lex *node = (struct ec_node_sh_lex *)gen_node;
241         struct ec_strvec *new_vec = NULL;
242         struct ec_parsed *child_parsed;
243         const char *str;
244         int ret;
245
246         if (ec_strvec_len(strvec) == 0) {
247                 new_vec = ec_strvec();
248         } else {
249                 str = ec_strvec_val(strvec, 0);
250                 new_vec = tokenize(str, 0, 0, NULL);
251         }
252         if (new_vec == NULL) {
253                 ret = -ENOMEM;
254                 goto fail;
255         }
256
257         ret = ec_node_parse_child(node->child, state, new_vec);
258         if (ret < 0)
259                 goto fail;
260
261         if ((unsigned)ret == ec_strvec_len(new_vec)) {
262                 ret = 1;
263         } else if (ret != EC_PARSED_NOMATCH) {
264                 child_parsed = ec_parsed_get_last_child(state);
265                 ec_parsed_del_child(state, child_parsed);
266                 ec_parsed_free(child_parsed);
267                 ret = EC_PARSED_NOMATCH;
268         }
269
270         ec_strvec_free(new_vec);
271         new_vec = NULL;
272
273         return ret;
274
275  fail:
276         ec_strvec_free(new_vec);
277         return ret;
278 }
279
280 static int
281 ec_node_sh_lex_complete(const struct ec_node *gen_node,
282                         struct ec_completed *completed,
283                         const struct ec_strvec *strvec)
284 {
285         struct ec_node_sh_lex *node = (struct ec_node_sh_lex *)gen_node;
286         struct ec_strvec *new_vec = NULL;
287         const char *str;
288         char missing_quote;
289         int ret;
290
291         if (ec_strvec_len(strvec) != 1)
292                 return 0;
293
294         str = ec_strvec_val(strvec, 0);
295 //      printf("\nold:%s\n", str);
296         new_vec = tokenize(str, 1, 1, &missing_quote);
297         if (new_vec == NULL)
298                 goto fail;
299 //      printf("new:%s\n", ec_strvec_val(new_vec, 0));
300
301         // XXX: complete should add the quotes for !EC_PARTIAL
302         // XXX: if no quotes, replace " " by "\ "
303         ret = ec_node_complete_child(node->child, completed, new_vec);
304         if (ret < 0)
305                 goto fail;
306
307         ec_strvec_free(new_vec);
308
309         return 0;
310
311  fail:
312         ec_strvec_free(new_vec);
313         return -1;
314 }
315
316 static void ec_node_sh_lex_free_priv(struct ec_node *gen_node)
317 {
318         struct ec_node_sh_lex *node = (struct ec_node_sh_lex *)gen_node;
319
320         ec_node_free(node->child);
321 }
322
323 static struct ec_node_type ec_node_sh_lex_type = {
324         .name = "sh_lex",
325         .parse = ec_node_sh_lex_parse,
326         .complete = ec_node_sh_lex_complete,
327         .size = sizeof(struct ec_node_sh_lex),
328         .free_priv = ec_node_sh_lex_free_priv,
329 };
330
331 EC_NODE_TYPE_REGISTER(ec_node_sh_lex_type);
332
333 struct ec_node *ec_node_sh_lex(const char *id, struct ec_node *child)
334 {
335         struct ec_node_sh_lex *node = NULL;
336
337         if (child == NULL)
338                 return NULL;
339
340         node = (struct ec_node_sh_lex *)__ec_node(&ec_node_sh_lex_type, id);
341         if (node == NULL) {
342                 ec_node_free(child);
343                 return NULL;
344         }
345
346         node->child = child;
347
348         return &node->gen;
349 }
350
351 /* LCOV_EXCL_START */
352 static int ec_node_sh_lex_testcase(void)
353 {
354         struct ec_node *node;
355         int ret = 0;
356
357         node = ec_node_sh_lex(NULL,
358                 EC_NODE_SEQ(NULL,
359                         ec_node_str(NULL, "foo"),
360                         ec_node_option(NULL,
361                                 ec_node_str(NULL, "toto")
362                         ),
363                         ec_node_str(NULL, "bar")
364                 )
365         );
366         if (node == NULL) {
367                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
368                 return -1;
369         }
370         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo bar");
371         ret |= EC_TEST_CHECK_PARSE(node, 1, "  foo   bar");
372         ret |= EC_TEST_CHECK_PARSE(node, 1, "  'foo' \"bar\"");
373         ret |= EC_TEST_CHECK_PARSE(node, 1, "  'f'oo 'toto' bar");
374         ret |= EC_TEST_CHECK_PARSE(node, -1, "  foo toto bar'");
375         ec_node_free(node);
376
377         /* test completion */
378         node = ec_node_sh_lex(NULL,
379                 EC_NODE_SEQ(NULL,
380                         ec_node_str(NULL, "foo"),
381                         ec_node_option(NULL,
382                                 ec_node_str(NULL, "toto")
383                         ),
384                         ec_node_str(NULL, "bar"),
385                         ec_node_str(NULL, "titi")
386                 )
387         );
388         if (node == NULL) {
389                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
390                 return -1;
391         }
392         ret |= EC_TEST_CHECK_COMPLETE(node,
393                 "", EC_NODE_ENDLIST,
394                 "foo", EC_NODE_ENDLIST);
395         ret |= EC_TEST_CHECK_COMPLETE(node,
396                 " ", EC_NODE_ENDLIST,
397                 "foo", EC_NODE_ENDLIST);
398         ret |= EC_TEST_CHECK_COMPLETE(node,
399                 "f", EC_NODE_ENDLIST,
400                 "foo", EC_NODE_ENDLIST);
401         ret |= EC_TEST_CHECK_COMPLETE(node,
402                 "foo", EC_NODE_ENDLIST,
403                 "foo", EC_NODE_ENDLIST);
404         ret |= EC_TEST_CHECK_COMPLETE(node,
405                 "foo ", EC_NODE_ENDLIST,
406                 "bar", "toto", EC_NODE_ENDLIST);
407         ret |= EC_TEST_CHECK_COMPLETE(node,
408                 "foo t", EC_NODE_ENDLIST,
409                 "toto", EC_NODE_ENDLIST);
410         ret |= EC_TEST_CHECK_COMPLETE(node,
411                 "foo b", EC_NODE_ENDLIST,
412                 "bar", EC_NODE_ENDLIST);
413         ret |= EC_TEST_CHECK_COMPLETE(node,
414                 "foo bar", EC_NODE_ENDLIST,
415                 "bar", EC_NODE_ENDLIST);
416         ret |= EC_TEST_CHECK_COMPLETE(node,
417                 "foo bar ", EC_NODE_ENDLIST,
418                 "titi", EC_NODE_ENDLIST);
419         ret |= EC_TEST_CHECK_COMPLETE(node,
420                 "foo toto bar ", EC_NODE_ENDLIST,
421                 "titi", EC_NODE_ENDLIST);
422         ret |= EC_TEST_CHECK_COMPLETE(node,
423                 "x", EC_NODE_ENDLIST,
424                 EC_NODE_ENDLIST);
425         ret |= EC_TEST_CHECK_COMPLETE(node,
426                 "foo barx", EC_NODE_ENDLIST,
427                 EC_NODE_ENDLIST);
428
429         ec_node_free(node);
430         return ret;
431 }
432 /* LCOV_EXCL_STOP */
433
434 static struct ec_test ec_node_sh_lex_test = {
435         .name = "node_sh_lex",
436         .test = ec_node_sh_lex_testcase,
437 };
438
439 EC_TEST_REGISTER(ec_node_sh_lex_test);