]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/file_analysis.c
tools: don't abort on malformed documentation lines.
[ccan] / tools / ccanlint / file_analysis.c
index e8c8ebc6dbb057f24849a6edd541c5c6cfda028d..852ecbfce851c31d85078d4a21d3e7657dcc6e8d 100644 (file)
@@ -1,3 +1,4 @@
+#include "config.h"
 #include "ccanlint.h"
 #include <ccan/talloc/talloc.h>
 #include <ccan/str/str.h>
@@ -9,6 +10,7 @@
 #include <ccan/noerr/noerr.h>
 #include <ccan/foreach/foreach.h>
 #include <ccan/asort/asort.h>
+#include <ccan/array_size/array_size.h>
 #include "../tools.h"
 #include <unistd.h>
 #include <sys/types.h>
 #include <stdarg.h>
 #include <assert.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, get_ccan_file_contents(f), "\n");
-
-       /* FIXME: is f->num_lines necessary? */
-       f->num_lines = talloc_array_length(f->lines) - 1;
-       return f->lines;
-}
-
 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->doc_sections = extract_doc_sections(f->lines, f->name);
        }
        return f->doc_sections;
 }
 
-struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name)
-{
-       struct ccan_file *f;
-
-       assert(dir[0] == '/');
-
-       f = talloc(ctx, struct ccan_file);
-       f->lines = NULL;
-       f->line_info = NULL;
-       f->doc_sections = NULL;
-       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;
-       return f;
-}
-
-static void add_files(struct manifest *m, const char *dir)
-{
-       DIR *d;
-       struct dirent *ent;
-       char **subs = NULL;
-
-       if (dir[0])
-               d = opendir(dir);
-       else
-               d = opendir(".");
-       if (!d)
-               err(1, "Opening directory %s", dir[0] ? dir : ".");
-
-       while ((ent = readdir(d)) != NULL) {
-               struct stat st;
-               struct ccan_file *f;
-               struct list_head *dest;
-               bool is_c_src;
-
-               if (ent->d_name[0] == '.')
-                       continue;
-
-               f = new_ccan_file(m, m->dir,
-                                 talloc_asprintf(m, "%s%s",
-                                                 dir, ent->d_name));
-               if (lstat(f->name, &st) != 0)
-                       err(1, "lstat %s", f->name);
-
-               if (S_ISDIR(st.st_mode)) {
-                       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)) {
-                       talloc_free(f);
-                       continue;
-               }
-
-               if (streq(f->name, "_info")) {
-                       m->info_file = f;
-                       continue;
-               }
-
-               is_c_src = strends(f->name, ".c");
-               if (!is_c_src && !strends(f->name, ".h")) {
-                       dest = &m->other_files;
-                       continue;
-               }
-
-               if (!strchr(f->name, '/')) {
-                       if (is_c_src)
-                               dest = &m->c_files;
-                       else
-                               dest = &m->h_files;
-               } else if (strstarts(f->name, "test/")) {
-                       if (is_c_src) {
-                               if (strstarts(f->name, "test/api"))
-                                       dest = &m->api_tests;
-                               else if (strstarts(f->name, "test/run"))
-                                       dest = &m->run_tests;
-                               else if (strstarts(f->name, "test/compile_ok"))
-                                       dest = &m->compile_ok_tests;
-                               else if (strstarts(f->name, "test/compile_fail"))
-                                       dest = &m->compile_fail_tests;
-                               else
-                                       dest = &m->other_test_c_files;
-                       } else
-                               dest = &m->other_test_files;
-               } else
-                       dest = &m->other_files;
-
-               list_add(dest, &f->list);
-       }
-       closedir(d);
-
-       /* Before we recurse, sanity check this is a ccan module. */ 
-       if (!dir[0]) {
-               size_t i;
-
-               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 < talloc_array_length(subs); i++)
-                       add_files(m, subs[i]);
-       }
-       talloc_free(subs);
-}
-
-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);
-       }
-       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;
-       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);
-       list_head_init(&m->run_tests);
-       list_head_init(&m->compile_ok_tests);
-       list_head_init(&m->compile_fail_tests);
-       list_head_init(&m->other_test_c_files);
-       list_head_init(&m->other_test_files);
-       list_head_init(&m->other_files);
-       list_head_init(&m->examples);
-       list_head_init(&m->mangled_examples);
-       list_head_init(&m->deps);
-
-       len = strlen(m->dir);
-       while (len && m->dir[len-1] == '/')
-               m->dir[--len] = '\0';
-
-       m->basename = strrchr(m->dir, '/');
-       if (!m->basename)
-               errx(1, "I don't expect to be run from the root directory");
-       m->basename++;
-
-       /* 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, '/');
-               if (!p)
-                       errx(1, "I expect the ccan root directory in ../..");
-               *p = '\0';
-               p = strrchr(ccan_dir, '/');
-               if (!p)
-                       errx(1, "I expect the ccan root directory in ../..");
-               *p = '\0';
-       }
-
-       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);
-
-       return m;
-}
-
 
 /**
  * remove_comments - strip comments from a line, return copy.
@@ -349,7 +96,7 @@ static char *remove_comments(const char *line, bool in_comment,
 
 static bool is_empty(const char *line)
 {
-       return strspn(line, " \t") == strlen(line);
+       return strspn(line, " \r\t") == strlen(line);
 }
 
 static bool continues(const char *line)
@@ -358,40 +105,6 @@ static bool continues(const char *line)
        return strends(line, "\\");
 }
 
-/* Get token if it's equal to token. */
-bool get_token(const char **line, const char *token)
-{
-       unsigned int toklen;
-
-       *line += strspn(*line, " \t");
-       if (isalnum(token[0]) || token[0] == '_')
-               toklen = strspn(*line, IDENT_CHARS);
-       else {
-               /* FIXME: real tokenizer handles ++ and other multi-chars.  */
-               toklen = strlen(token);
-       }
-
-       if (toklen == strlen(token) && !strncmp(*line, token, toklen)) {
-               *line += toklen;
-               return true;
-       }
-       return false;
-}
-
-char *get_symbol_token(void *ctx, const char **line)
-{
-       unsigned int toklen;
-       char *ret;
-
-       *line += strspn(*line, " \t");
-       toklen = strspn(*line, IDENT_CHARS);
-       if (!toklen)
-               return NULL;
-       ret = talloc_strndup(ctx, *line, toklen);
-       *line += toklen;
-       return ret;
-}
-
 static bool parse_hash_if(struct pp_conditions *cond, const char **line)
 {
        bool brackets, defined;
@@ -406,6 +119,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;
 }
 
@@ -670,3 +394,13 @@ void score_file_error(struct score *score, struct ccan_file *f, unsigned line,
                score->error = talloc_append_string(score->error,
                                    "... more (use -vv to see them all)\n");
 }
+
+char *get_or_compile_info(const void *ctx, const char *dir)
+{
+       struct manifest *m = get_manifest(NULL, dir);
+
+       if (!m->info_file->compiled[COMPILE_NORMAL])
+               m->info_file->compiled[COMPILE_NORMAL] = compile_info(m, dir);
+
+       return m->info_file->compiled[COMPILE_NORMAL];
+}