]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.c
likely: use htable_type
[ccan] / tools / ccanlint / ccanlint.c
index 15d131e20073c2106ec2963d07a2ed76c5492730..5f443d6fafd4ec4f9cbea5b62ebf054be0d92a98 100644 (file)
@@ -31,6 +31,8 @@
 #include <ccan/talloc/talloc.h>
 #include <ccan/opt/opt.h>
 #include <ccan/foreach/foreach.h>
+#include <ccan/grab_file/grab_file.h>
+#include <ccan/cast/cast.h>
 
 int verbose = 0;
 static LIST_HEAD(compulsory_tests);
@@ -41,6 +43,12 @@ static struct btree *cmdline_exclude;
 static struct btree *info_exclude;
 static unsigned int timeout;
 
+/* These are overridden at runtime if we can find config.h */
+const char *compiler = NULL;
+const char *cflags = NULL;
+
+const char *config_header;
+
 #if 0
 static void indent_print(const char *string)
 {
@@ -149,11 +157,13 @@ static bool run_test(struct ccanlint *i,
        }
 
        if ((!quiet && !score->pass) || verbose) {
-               if (score->error)
-                       printf("%s", score->error);
-               if (!quiet && !score->pass && i->handle)
-                       i->handle(m, score);
+               if (score->error) {
+                       printf("%s%s", score->error,
+                              strends(score->error, "\n") ? "" : "\n");
+               }
        }
+       if (!quiet && score->score < score->total && i->handle)
+               i->handle(m, score);
 
        *running_score += score->score;
        *running_total += score->total;
@@ -176,6 +186,8 @@ static bool run_test(struct ccanlint *i,
 static void register_test(struct list_head *h, struct ccanlint *test)
 {
        list_add(h, &test->list);
+       test->options = talloc_array(NULL, char *, 1);
+       test->options[0] = NULL;
 }
 
 /**
@@ -210,6 +222,13 @@ static struct ccanlint *find_test(const char *key)
        return NULL;
 }
 
+bool is_excluded(const char *name)
+{
+       return btree_lookup(cmdline_exclude, name) != NULL
+               || btree_lookup(info_exclude, name) != NULL
+               || find_test(name)->skip != NULL;
+}
+
 #undef REGISTER_TEST
 #define REGISTER_TEST(name, ...) extern struct ccanlint name
 #include "generated-normal-tests"
@@ -275,24 +294,29 @@ static void init_tests(void)
        }
        btree_delete(keys);
        btree_delete(names);
+}
 
-       if (!verbose)
-               return;
+static void print_test_depends(void)
+{
+       struct list_head *list;
 
        foreach_ptr(list, &compulsory_tests, &normal_tests) {
+               struct ccanlint *c;
                printf("\%s Tests\n",
                       list == &compulsory_tests ? "Compulsory" : "Normal");
 
-               if (!list_empty(&c->dependencies)) {
-                       const struct dependent *d;
-                       printf("These depend on us:\n");
-                       list_for_each(&c->dependencies, d, node)
-                               printf("\t%s\n", d->dependent->name);
+               list_for_each(list, c, list) {
+                       if (!list_empty(&c->dependencies)) {
+                               const struct dependent *d;
+                               printf("These depend on %s:\n", c->key);
+                               list_for_each(&c->dependencies, d, node)
+                                       printf("\t%s\n", d->dependent->key);
+                       }
                }
        }
 }
 
-static int show_tmpdir(char *dir)
+static int show_tmpdir(const char *dir)
 {
        printf("You can find ccanlint working files in '%s'\n", dir);
        return 0;
@@ -394,11 +418,30 @@ static char **collapse(char **lines, unsigned int *nump)
                if (lines[i][0])
                        lines[j++] = lines[i];
        }
+       lines[j] = NULL;
        if (nump)
                *nump = j;
        return lines;
 }
 
+
+static void add_options(struct ccanlint *test, char **options,
+                       unsigned int num_options)
+{
+       unsigned int num;
+
+       if (!test->options)
+               num = 0;
+       else
+               /* -1, because last one is NULL. */
+               num = talloc_array_length(test->options) - 1;
+
+       test->options = talloc_realloc(NULL, test->options,
+                                      char *,
+                                      num + num_options + 1);
+       memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *));
+}
+
 static void add_info_options(struct ccan_file *info, bool mark_fails)
 {
        struct doc_section *d;
@@ -410,9 +453,10 @@ static void add_info_options(struct ccan_file *info, bool mark_fails)
                        continue;
 
                for (i = 0; i < d->num_lines; i++) {
+                       unsigned int num_words;
                        char **words = collapse(strsplit(d, d->lines[i], " \t"),
-                                               NULL);
-                       if (!words[0])
+                                               &num_words);
+                       if (num_words == 0)
                                continue;
 
                        if (strncmp(words[0], "//", 2) == 0)
@@ -439,14 +483,49 @@ static void add_info_options(struct ccan_file *info, bool mark_fails)
                                if (!test->takes_options)
                                        warnx("%s: %s doesn't take options",
                                              info->fullname, words[0]);
-                               /* Copy line exactly into options. */
-                               test->options = strstr(d->lines[i], words[0])
-                                       + strlen(words[0]);
+                               add_options(test, words+1, num_words-1);
                        }
                }
        }
 }
 
+/* If options are of form "filename:<option>" they only apply to that file */
+char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
+{
+       char **ret;
+       unsigned int i, j = 0;
+
+       /* Fast path. */
+       if (!test->options[0])
+               return test->options;
+
+       ret = talloc_array(f, char *, talloc_array_length(test->options));
+       for (i = 0; test->options[i]; i++) {
+               char *optname;
+
+               if (!test->options[i] || !strchr(test->options[i], ':')) {
+                       optname = test->options[i];
+               } else if (strstarts(test->options[i], f->name)
+                          && test->options[i][strlen(f->name)] == ':') {
+                       optname = test->options[i] + strlen(f->name) + 1;
+               } else
+                       continue;
+
+               /* FAIL overrides anything else. */
+               if (streq(optname, "FAIL")) {
+                       ret = talloc_array(f, char *, 2);
+                       ret[0] = (char *)"FAIL";
+                       ret[1] = NULL;
+                       return ret;
+               }
+               ret[j++] = optname;
+       }
+       ret[j] = NULL;
+
+       /* Shrink it to size so talloc_array_length() works as expected. */
+       return talloc_realloc(NULL, ret, char *, j + 1);
+}
+
 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
 {
        const struct dependent *d;
@@ -473,9 +552,108 @@ static void skip_unrelated_tests(struct ccanlint *target)
                                i->skip = "not relevant to target";
 }
 
+static char *demangle_string(char *string)
+{
+       unsigned int i;
+       const char mapfrom[] = "abfnrtv";
+       const char mapto[] = "\a\b\f\n\r\t\v";
+
+       if (!strchr(string, '"'))
+               return NULL;
+       string = strchr(string, '"') + 1;
+       if (!strrchr(string, '"'))
+               return NULL;
+       *strrchr(string, '"') = '\0';
+
+       for (i = 0; i < strlen(string); i++) {
+               if (string[i] == '\\') {
+                       char repl;
+                       unsigned len = 0;
+                       const char *p = strchr(mapfrom, string[i+1]);
+                       if (p) {
+                               repl = mapto[p - mapfrom];
+                               len = 1;
+                       } else if (strlen(string+i+1) >= 3) {
+                               if (string[i+1] == 'x') {
+                                       repl = (string[i+2]-'0')*16
+                                               + string[i+3]-'0';
+                                       len = 3;
+                               } else if (cisdigit(string[i+1])) {
+                                       repl = (string[i+2]-'0')*8*8
+                                               + (string[i+3]-'0')*8
+                                               + (string[i+4]-'0');
+                                       len = 3;
+                               }
+                       }
+                       if (len == 0) {
+                               repl = string[i+1];
+                               len = 1;
+                       }
+
+                       string[i] = repl;
+                       memmove(string + i + 1, string + i + len + 1,
+                               strlen(string + i + len + 1) + 1);
+               }
+       }
+
+       return string;
+}
+
+
+static void read_config_header(void)
+{
+       char *fname = talloc_asprintf(NULL, "%s/config.h", ccan_dir);
+       char **lines;
+       unsigned int i;
+
+       config_header = grab_file(NULL, fname, NULL);
+       if (!config_header) {
+               talloc_free(fname);
+               return;
+       }
+
+       lines = strsplit(config_header, config_header, "\n");
+       for (i = 0; i < talloc_array_length(lines) - 1; i++) {
+               char *sym;
+               const char **line = (const char **)&lines[i];
+
+               if (!get_token(line, "#"))
+                       continue;
+               if (!get_token(line, "define"))
+                       continue;
+               sym = get_symbol_token(lines, line);
+               if (streq(sym, "CCAN_COMPILER") && !compiler) {
+                       compiler = demangle_string(lines[i]);
+                       if (!compiler)
+                               errx(1, "%s:%u:could not parse CCAN_COMPILER",
+                                    fname, i+1);
+                       if (verbose > 1)
+                               printf("%s: compiler set to '%s'\n",
+                                      fname, compiler);
+               } else if (streq(sym, "CCAN_CFLAGS") && !cflags) {
+                       cflags = demangle_string(lines[i]);
+                       if (!cflags)
+                               errx(1, "%s:%u:could not parse CCAN_CFLAGS",
+                                    fname, i+1);
+                       if (verbose > 1)
+                               printf("%s: compiler flags set to '%s'\n",
+                                      fname, cflags);
+               }
+       }
+       if (!compiler)
+               compiler = CCAN_COMPILER;
+       if (!cflags)
+               compiler = CCAN_CFLAGS;
+}
+
+static char *opt_set_const_charp(const char *arg, const char **p)
+{
+       return opt_set_charp(arg, cast_const2(char **, p));
+}
+
 int main(int argc, char *argv[])
 {
-       bool summary = false;
+       bool summary = false, pass = true;
        unsigned int score = 0, total_score = 0;
        struct manifest *m;
        struct ccanlint *i;
@@ -510,6 +688,10 @@ int main(int argc, char *argv[])
        opt_register_arg("--target <testname>", opt_set_charp,
                         NULL, &target,
                         "only run one test (and its prerequisites)");
+       opt_register_arg("--compiler <compiler>", opt_set_const_charp,
+                        NULL, &compiler, "set the compiler");
+       opt_register_arg("--cflags <flags>", opt_set_const_charp,
+                        NULL, &cflags, "set the compiler flags");
        opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
                           "\nA program for checking and guiding development"
                           " of CCAN modules.",
@@ -527,12 +709,15 @@ int main(int argc, char *argv[])
                dir[strlen(dir)-1] = '\0';
        if (dir != base_dir)
                prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
-       if (verbose >= 3)
+       if (verbose >= 3) {
                compile_verbose = true;
+               print_test_depends();
+       }
        if (verbose >= 4)
                tools_verbose = true;
 
        m = get_manifest(talloc_autofree_context(), dir);
+       read_config_header();
 
        /* Create a symlink from temp dir back to src dir's test directory. */
        if (symlink(talloc_asprintf(m, "%s/test", dir),
@@ -557,11 +742,12 @@ int main(int argc, char *argv[])
        }
 
        /* --target overrides known FAIL from _info */
-       add_info_options(m->info_file, !target);
+       if (m->info_file)
+               add_info_options(m->info_file, !target);
 
        while ((i = get_next_test(&normal_tests)) != NULL)
-               run_test(i, summary, &score, &total_score, m);
+               pass &= run_test(i, summary, &score, &total_score, m);
 
        printf("%sTotal score: %u/%u\n", prefix, score, total_score);
-       return 0;
+       return pass ? 0 : 1;
 }