kconfig: support user-defined function and recursively expanded variable
[carl9170fw.git] / config / preprocess.c
index a2eb2eb0292978092e5ef8895fea5ed163ce66cd..46487fe6b36cd99e9ea04cc0bc2cbe7708b98121 100644 (file)
 
 #include "list.h"
 
+#define ARRAY_SIZE(arr)                (sizeof(arr) / sizeof((arr)[0]))
+
+static char *expand_string_with_args(const char *in, int argc, char *argv[]);
+
 static void __attribute__((noreturn)) pperror(const char *format, ...)
 {
        va_list ap;
@@ -92,21 +96,249 @@ void env_write_dep(FILE *f, const char *autoconfig_name)
        }
 }
 
-static char *eval_clause(const char *str, size_t len)
+/*
+ * Built-in functions
+ */
+struct function {
+       const char *name;
+       unsigned int min_args;
+       unsigned int max_args;
+       char *(*func)(int argc, char *argv[]);
+};
+
+static char *do_shell(int argc, char *argv[])
+{
+       FILE *p;
+       char buf[256];
+       char *cmd;
+       size_t nread;
+       int i;
+
+       cmd = argv[0];
+
+       p = popen(cmd, "r");
+       if (!p) {
+               perror(cmd);
+               exit(1);
+       }
+
+       nread = fread(buf, 1, sizeof(buf), p);
+       if (nread == sizeof(buf))
+               nread--;
+
+       /* remove trailing new lines */
+       while (buf[nread - 1] == '\n')
+               nread--;
+
+       buf[nread] = 0;
+
+       /* replace a new line with a space */
+       for (i = 0; i < nread; i++) {
+               if (buf[i] == '\n')
+                       buf[i] = ' ';
+       }
+
+       if (pclose(p) == -1) {
+               perror(cmd);
+               exit(1);
+       }
+
+       return xstrdup(buf);
+}
+
+static const struct function function_table[] = {
+       /* Name         MIN     MAX     Function */
+       { "shell",      1,      1,      do_shell },
+};
+
+#define FUNCTION_MAX_ARGS              16
+
+static char *function_expand(const char *name, int argc, char *argv[])
+{
+       const struct function *f;
+       int i;
+
+       for (i = 0; i < ARRAY_SIZE(function_table); i++) {
+               f = &function_table[i];
+               if (strcmp(f->name, name))
+                       continue;
+
+               if (argc < f->min_args)
+                       pperror("too few function arguments passed to '%s'",
+                               name);
+
+               if (argc > f->max_args)
+                       pperror("too many function arguments passed to '%s'",
+                               name);
+
+               return f->func(argc, argv);
+       }
+
+       return NULL;
+}
+
+/*
+ * Variables (and user-defined functions)
+ */
+static LIST_HEAD(variable_list);
+
+struct variable {
+       char *name;
+       char *value;
+       struct list_head node;
+};
+
+static struct variable *variable_lookup(const char *name)
+{
+       struct variable *v;
+
+       list_for_each_entry(v, &variable_list, node) {
+               if (!strcmp(name, v->name))
+                       return v;
+       }
+
+       return NULL;
+}
+
+static char *variable_expand(const char *name, int argc, char *argv[])
+{
+       struct variable *v;
+
+       v = variable_lookup(name);
+       if (!v)
+               return NULL;
+
+       return expand_string_with_args(v->value, argc, argv);
+}
+
+void variable_add(const char *name, const char *value)
+{
+       struct variable *v;
+
+       v = variable_lookup(name);
+       if (v) {
+               free(v->value);
+       } else {
+               v = xmalloc(sizeof(*v));
+               v->name = xstrdup(name);
+               list_add_tail(&v->node, &variable_list);
+       }
+
+       v->value = xstrdup(value);
+}
+
+static void variable_del(struct variable *v)
+{
+       list_del(&v->node);
+       free(v->name);
+       free(v->value);
+       free(v);
+}
+
+void variable_all_del(void)
 {
-       char *tmp, *name, *res;
+       struct variable *v, *tmp;
+
+       list_for_each_entry_safe(v, tmp, &variable_list, node)
+               variable_del(v);
+}
+
+/*
+ * Evaluate a clause with arguments.  argc/argv are arguments from the upper
+ * function call.
+ *
+ * Returned string must be freed when done
+ */
+static char *eval_clause(const char *str, size_t len, int argc, char *argv[])
+{
+       char *tmp, *name, *res, *endptr, *prev, *p;
+       int new_argc = 0;
+       char *new_argv[FUNCTION_MAX_ARGS];
+       int nest = 0;
+       int i;
+       unsigned long n;
 
        tmp = xstrndup(str, len);
 
-       name = expand_string(tmp);
+       /*
+        * If variable name is '1', '2', etc.  It is generally an argument
+        * from a user-function call (i.e. local-scope variable).  If not
+        * available, then look-up global-scope variables.
+        */
+       n = strtoul(tmp, &endptr, 10);
+       if (!*endptr && n > 0 && n <= argc) {
+               res = xstrdup(argv[n - 1]);
+               goto free_tmp;
+       }
+
+       prev = p = tmp;
 
-       res = env_expand(name);
+       /*
+        * Split into tokens
+        * The function name and arguments are separated by a comma.
+        * For example, if the function call is like this:
+        *   $(foo,$(x),$(y))
+        *
+        * The input string for this helper should be:
+        *   foo,$(x),$(y)
+        *
+        * and split into:
+        *   new_argv[0] = 'foo'
+        *   new_argv[1] = '$(x)'
+        *   new_argv[2] = '$(y)'
+        */
+       while (*p) {
+               if (nest == 0 && *p == ',') {
+                       *p = 0;
+                       if (new_argc >= FUNCTION_MAX_ARGS)
+                               pperror("too many function arguments");
+                       new_argv[new_argc++] = prev;
+                       prev = p + 1;
+               } else if (*p == '(') {
+                       nest++;
+               } else if (*p == ')') {
+                       nest--;
+               }
+
+               p++;
+       }
+       new_argv[new_argc++] = prev;
+
+       /*
+        * Shift arguments
+        * new_argv[0] represents a function name or a variable name.  Put it
+        * into 'name', then shift the rest of the arguments.  This simplifies
+        * 'const' handling.
+        */
+       name = expand_string_with_args(new_argv[0], argc, argv);
+       new_argc--;
+       for (i = 0; i < new_argc; i++)
+               new_argv[i] = expand_string_with_args(new_argv[i + 1],
+                                                     argc, argv);
+
+       /* Search for variables */
+       res = variable_expand(name, new_argc, new_argv);
        if (res)
                goto free;
 
+       /* Look for built-in functions */
+       res = function_expand(name, new_argc, new_argv);
+       if (res)
+               goto free;
+
+       /* Last, try environment variable */
+       if (new_argc == 0) {
+               res = env_expand(name);
+               if (res)
+                       goto free;
+       }
+
        res = xstrdup("");
 free:
+       for (i = 0; i < new_argc; i++)
+               free(new_argv[i]);
        free(name);
+free_tmp:
        free(tmp);
 
        return res;
@@ -124,14 +356,14 @@ free:
  * after the corresponding closing parenthesis, in this case, *str will be
  *     $(BAR)
  */
-char *expand_dollar(const char **str)
+static char *expand_dollar_with_args(const char **str, int argc, char *argv[])
 {
        const char *p = *str;
        const char *q;
        int nest = 0;
 
        /*
-        * In Kconfig, variable references always start with "$(".
+        * In Kconfig, variable/function references always start with "$(".
         * Neither single-letter variables as in $A nor curly braces as in ${CC}
         * are supported.  '$' not followed by '(' loses its special meaning.
         */
@@ -158,10 +390,16 @@ char *expand_dollar(const char **str)
        /* Advance 'str' to after the expanded initial portion of the string */
        *str = q + 1;
 
-       return eval_clause(p, q - p);
+       return eval_clause(p, q - p, argc, argv);
 }
 
-static char *__expand_string(const char **str, bool (*is_end)(char c))
+char *expand_dollar(const char **str)
+{
+       return expand_dollar_with_args(str, 0, NULL);
+}
+
+static char *__expand_string(const char **str, bool (*is_end)(char c),
+                            int argc, char *argv[])
 {
        const char *in, *p;
        char *expansion, *out;
@@ -177,7 +415,7 @@ static char *__expand_string(const char **str, bool (*is_end)(char c))
                if (*p == '$') {
                        in_len = p - in;
                        p++;
-                       expansion = expand_dollar(&p);
+                       expansion = expand_dollar_with_args(&p, argc, argv);
                        out_len += in_len + strlen(expansion);
                        out = xrealloc(out, out_len);
                        strncat(out, in, in_len);
@@ -210,13 +448,18 @@ static bool is_end_of_str(char c)
 }
 
 /*
- * Expand variables in the given string.  Undefined variables
+ * Expand variables and functions in the given string.  Undefined variables
  * expand to an empty string.
  * The returned string must be freed when done.
  */
+static char *expand_string_with_args(const char *in, int argc, char *argv[])
+{
+       return __expand_string(&in, is_end_of_str, argc, argv);
+}
+
 char *expand_string(const char *in)
 {
-       return __expand_string(&in, is_end_of_str);
+       return expand_string_with_args(in, 0, NULL);
 }
 
 static bool is_end_of_token(char c)
@@ -234,5 +477,5 @@ static bool is_end_of_token(char c)
  */
 char *expand_one_token(const char **str)
 {
-       return __expand_string(str, is_end_of_token);
+       return __expand_string(str, is_end_of_token, 0, NULL);
 }