]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/file_analysis.c
ccanlint: add simple check for comment referring to LICENSE file.
[ccan] / tools / ccanlint / file_analysis.c
index 4908a895423b98eddcd70fc5d973dc60e871d4b9..c20211677d6b3db3063ca0947778232d1ca18718 100644 (file)
@@ -1,9 +1,15 @@
+#include "config.h"
 #include "ccanlint.h"
 #include <ccan/talloc/talloc.h>
 #include <ccan/str/str.h>
 #include <ccan/str_talloc/str_talloc.h>
+#include <ccan/talloc_link/talloc_link.h>
+#include <ccan/hash/hash.h>
+#include <ccan/htable/htable_type.h>
 #include <ccan/grab_file/grab_file.h>
 #include <ccan/noerr/noerr.h>
+#include <ccan/foreach/foreach.h>
+#include <ccan/asort/asort.h>
 #include "../tools.h"
 #include <unistd.h>
 #include <sys/types.h>
 
 const char *ccan_dir;
 
+static size_t dir_hash(const char *name)
+{
+       return hash(name, strlen(name), 0);
+}
+
+static const char *manifest_name(const struct manifest *m)
+{
+       return m->dir;
+}
+
+static bool dir_cmp(const struct manifest *m, const char *dir)
+{
+       return strcmp(m->dir, dir) == 0;
+}
+
+HTABLE_DEFINE_TYPE(struct manifest, manifest_name, dir_hash, dir_cmp, manifest);
+static struct htable_manifest *manifests;
+
+const char *get_ccan_file_contents(struct ccan_file *f)
+{
+       if (!f->contents) {
+               f->contents = grab_file(f, f->fullname, &f->contents_size);
+               if (!f->contents)
+                       err(1, "Reading file %s", f->fullname);
+       }
+       return f->contents;
+}
+
 char **get_ccan_file_lines(struct ccan_file *f)
 {
        if (!f->lines)
-               f->lines = strsplit(f, f->contents, "\n", &f->num_lines);
+               f->lines = strsplit(f, get_ccan_file_contents(f), "\n");
 
+       /* FIXME: is f->num_lines necessary? */
+       f->num_lines = talloc_array_length(f->lines) - 1;
        return f->lines;
 }
 
@@ -30,7 +66,7 @@ struct list_head *get_ccan_file_docs(struct ccan_file *f)
 {
        if (!f->doc_sections) {
                get_ccan_file_lines(f);
-               f->doc_sections = extract_doc_sections(f->lines, f->num_lines);
+               f->doc_sections = extract_doc_sections(f->lines);
        }
        return f->doc_sections;
 }
@@ -48,6 +84,9 @@ struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name)
        f->compiled = NULL;
        f->name = talloc_steal(f, name);
        f->fullname = talloc_asprintf(f, "%s/%s", dir, f->name);
+       f->contents = NULL;
+       f->cov_compiled = NULL;
+       f->simplified = NULL;
        return f;
 }
 
@@ -55,6 +94,7 @@ static void add_files(struct manifest *m, const char *dir)
 {
        DIR *d;
        struct dirent *ent;
+       char **subs = NULL;
 
        if (dir[0])
                d = opendir(dir);
@@ -79,8 +119,9 @@ static void add_files(struct manifest *m, const char *dir)
                        err(1, "lstat %s", f->name);
 
                if (S_ISDIR(st.st_mode)) {
-                       f->name = talloc_append_string(f->name, "/");
-                       add_files(m, f->name);
+                       size_t len = talloc_array_length(subs);
+                       subs = talloc_realloc(m, subs, char *, len+1);
+                       subs[len] = talloc_append_string(f->name, "/");
                        continue;
                }
                if (!S_ISREG(st.st_mode)) {
@@ -90,24 +131,13 @@ static void add_files(struct manifest *m, const char *dir)
 
                if (streq(f->name, "_info")) {
                        m->info_file = f;
-                       f->contents = grab_file(f, f->name, &f->contents_size);
-                       if (!f->contents)
-                               err(1, "Reading file %s", f->name);
                        continue;
                }
 
                is_c_src = strends(f->name, ".c");
                if (!is_c_src && !strends(f->name, ".h")) {
-                       /* We don't pull in contents of non-source files */
                        dest = &m->other_files;
-                       continue;
-               }
-
-               f->contents = grab_file(f, f->name, &f->contents_size);
-               if (!f->contents)
-                       err(1, "Reading file %s", f->name);
-
-               if (!strchr(f->name, '/')) {
+               } else if (!strchr(f->name, '/')) {
                        if (is_c_src)
                                dest = &m->c_files;
                        else
@@ -132,39 +162,75 @@ static void add_files(struct manifest *m, const char *dir)
                list_add(dest, &f->list);
        }
        closedir(d);
-}
 
-char *report_on_lines(struct list_head *files,
-                     char *(*report)(const char *),
-                     char *sofar)
-{
-       struct ccan_file *f;
+       /* Before we recurse, sanity check this is a ccan module. */ 
+       if (!dir[0]) {
+               size_t i;
 
-       list_for_each(files, f, list) {
-               unsigned int i;
-               char **lines = get_ccan_file_lines(f);
+               if (!m->info_file
+                   && list_empty(&m->c_files)
+                   && list_empty(&m->h_files))
+                       errx(1, "No _info, C or H files found here!");
 
-               for (i = 0; i < f->num_lines; i++) {
-                       char *r = report(lines[i]);
-                       if (!r)
-                               continue;
+               for (i = 0; i < talloc_array_length(subs); i++)
+                       add_files(m, subs[i]);
+       }
+       talloc_free(subs);
+}
 
-                       sofar = talloc_asprintf_append(sofar,
-                                                      "%s:%u:%s\n",
-                                                      f->name, i+1, r);
-                       talloc_free(r);
-               }
+static int cmp_names(struct ccan_file *const *a, struct ccan_file *const *b,
+                    void *unused)
+{
+       return strcmp((*a)->name, (*b)->name);
+}
+
+static void sort_files(struct list_head *list)
+{
+       struct ccan_file **files = NULL, *f;
+       unsigned int i, num;
+
+       num = 0;
+       while ((f = list_top(list, struct ccan_file, list)) != NULL) {
+               files = talloc_realloc(NULL, files, struct ccan_file *, num+1);
+               files[num++] = f;
+               list_del(&f->list);
        }
-       return sofar;
+       asort(files, num, cmp_names, NULL);
+
+       for (i = 0; i < num; i++)
+               list_add_tail(list, &files[i]->list);
+       talloc_free(files);
 }
 
 struct manifest *get_manifest(const void *ctx, const char *dir)
 {
-       struct manifest *m = talloc(ctx, struct manifest);
-       char *olddir;
+       struct manifest *m;
+       char *olddir, *canon_dir;
        unsigned int len;
+       struct list_head *list;
+
+       if (!manifests)
+               manifests = htable_manifest_new();
+
+       olddir = talloc_getcwd(NULL);
+       if (!olddir)
+               err(1, "Getting current directory");
+
+       if (chdir(dir) != 0)
+               err(1, "Failed to chdir to %s", dir);
 
+       canon_dir = talloc_getcwd(olddir);
+       if (!canon_dir)
+               err(1, "Getting current directory");
+
+       m = htable_manifest_get(manifests, canon_dir);
+       if (m)
+               goto done;
+
+       m = talloc_linked(ctx, talloc(NULL, struct manifest));
        m->info_file = NULL;
+       m->compiled = NULL;
+       m->dir = talloc_steal(m, canon_dir);
        list_head_init(&m->c_files);
        list_head_init(&m->h_files);
        list_head_init(&m->api_tests);
@@ -175,18 +241,8 @@ struct manifest *get_manifest(const void *ctx, const char *dir)
        list_head_init(&m->other_test_files);
        list_head_init(&m->other_files);
        list_head_init(&m->examples);
-       list_head_init(&m->dep_dirs);
-
-       olddir = talloc_getcwd(NULL);
-       if (!olddir)
-               err(1, "Getting current directory");
-
-       if (chdir(dir) != 0)
-               err(1, "Failed to chdir to %s", dir);
-
-       m->dir = talloc_getcwd(m);
-       if (!m->dir)
-               err(1, "Getting current directory");
+       list_head_init(&m->mangled_examples);
+       list_head_init(&m->deps);
 
        len = strlen(m->dir);
        while (len && m->dir[len-1] == '/')
@@ -199,16 +255,29 @@ struct manifest *get_manifest(const void *ctx, const char *dir)
 
        /* We expect the ccan dir to be two levels above module dir. */
        if (!ccan_dir) {
-               char *p;
-               ccan_dir = talloc_strdup(NULL, m->dir);
-               p = strrchr(ccan_dir, '/');
+               char *p, *dir;
+               dir = talloc_strdup(NULL, m->dir);
+               p = strrchr(dir, '/');
+               if (!p)
+                       errx(1, "I expect the ccan root directory in ../..");
                *p = '\0';
-               p = strrchr(ccan_dir, '/');
+               p = strrchr(dir, '/');
+               if (!p)
+                       errx(1, "I expect the ccan root directory in ../..");
                *p = '\0';
+               ccan_dir = dir;
        }
 
        add_files(m, "");
 
+       /* Nicer to run tests in a predictable order. */
+       foreach_ptr(list, &m->api_tests, &m->run_tests, &m->compile_ok_tests,
+                   &m->compile_fail_tests)
+               sort_files(list);
+
+       htable_manifest_add(manifests, m);
+
+done:
        if (chdir(olddir) != 0)
                err(1, "Returning to original directory '%s'", olddir);
        talloc_free(olddir);
@@ -295,7 +364,7 @@ bool get_token(const char **line, const char *token)
        unsigned int toklen;
 
        *line += strspn(*line, " \t");
-       if (isalnum(token[0]) || token[0] == '_')
+       if (cisalnum(token[0]) || token[0] == '_')
                toklen = strspn(*line, IDENT_CHARS);
        else {
                /* FIXME: real tokenizer handles ++ and other multi-chars.  */
@@ -337,6 +406,17 @@ static bool parse_hash_if(struct pp_conditions *cond, const char **line)
                return false;
        if (!defined)
                cond->type = PP_COND_IF;
+
+       /* FIXME: We just chain them, ignoring operators. */
+       if (get_token(line, "||") || get_token(line, "&&")) {
+               struct pp_conditions *sub = talloc(cond, struct pp_conditions);
+
+               sub->parent = cond->parent;
+               sub->type = PP_COND_IFDEF;
+               if (parse_hash_if(sub, line))
+                       cond->parent = sub;
+       }
+
        return true;
 }
 
@@ -568,3 +648,36 @@ enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
        return ret;
 }
 
+void score_file_error(struct score *score, struct ccan_file *f, unsigned line,
+                     const char *errorfmt, ...)
+{
+       va_list ap;
+
+       struct file_error *fe = talloc(score, struct file_error);
+       fe->file = f;
+       fe->line = line;
+       list_add_tail(&score->per_file_errors, &fe->list);
+
+       if (!score->error)
+               score->error = talloc_strdup(score, "");
+       
+       if (verbose < 2 && strcount(score->error, "\n") > 5)
+               return;
+
+       if (line)
+               score->error = talloc_asprintf_append(score->error,
+                                                     "%s:%u:",
+                                                     f->fullname, line);
+       else
+               score->error = talloc_asprintf_append(score->error,
+                                                     "%s:", f->fullname);
+
+       va_start(ap, errorfmt);
+       score->error = talloc_vasprintf_append(score->error, errorfmt, ap);
+       va_end(ap);
+       score->error = talloc_append_string(score->error, "\n");
+
+       if (verbose < 2 && strcount(score->error, "\n") > 5)
+               score->error = talloc_append_string(score->error,
+                                   "... more (use -vv to see them all)\n");
+}