git.ozlabs.org Git - ccan/blob - tools/manifest.c

   1 #include "config.h"
   2 #include "manifest.h"
   3 #include "tools.h"
   4 #include <ccan/str/str.h>
   5 #include <ccan/tal/link/link.h>
   6 #include <ccan/tal/path/path.h>
   7 #include <ccan/hash/hash.h>
   8 #include <ccan/htable/htable_type.h>
   9 #include <ccan/noerr/noerr.h>
  10 #include <ccan/foreach/foreach.h>
  11 #include <ccan/asort/asort.h>
  12 #include <ccan/array_size/array_size.h>
  13 #include <ccan/err/err.h>
  14 #include <unistd.h>
  15 #include <sys/types.h>
  16 #include <sys/stat.h>
  17 #include <fcntl.h>
  18 #include <errno.h>
  19 #include <dirent.h>
  20 #include <ctype.h>
  21 #include <stdarg.h>
  22 #include <assert.h>
  23
  24 static size_t dir_hash(const char *name)
  25 {
  26         return hash(name, strlen(name), 0);
  27 }
  28
  29 static const char *manifest_name(const struct manifest *m)
  30 {
  31         return m->dir;
  32 }
  33
  34 static bool dir_cmp(const struct manifest *m, const char *dir)
  35 {
  36         return strcmp(m->dir, dir) == 0;
  37 }
  38
  39 HTABLE_DEFINE_TYPE(struct manifest, manifest_name, dir_hash, dir_cmp,
  40                    htable_manifest);
  41 static struct htable_manifest *manifests;
  42
  43 const char *get_ccan_file_contents(struct ccan_file *f)
  44 {
  45         if (!f->contents) {
  46                 f->contents = tal_grab_file(f, f->fullname,
  47                                                &f->contents_size);
  48                 if (!f->contents)
  49                         err(1, "Reading file %s", f->fullname);
  50         }
  51         return f->contents;
  52 }
  53
  54 char **get_ccan_file_lines(struct ccan_file *f)
  55 {
  56         if (!f->lines)
  57                 f->lines = tal_strsplit(f, get_ccan_file_contents(f), "\n",
  58                                         STR_EMPTY_OK);
  59
  60         return f->lines;
  61 }
  62
  63 struct ccan_file *new_ccan_file(const void *ctx, const char *dir,
  64                                 const char *name)
  65 {
  66         struct ccan_file *f;
  67         unsigned int i;
  68
  69         assert(dir[0] == '/');
  70
  71         f = tal(ctx, struct ccan_file);
  72         f->lines = NULL;
  73         f->line_info = NULL;
  74         f->doc_sections = NULL;
  75         for (i = 0; i < ARRAY_SIZE(f->compiled); i++)
  76                 f->compiled[i] = NULL;
  77         f->name = tal_strdup(f, name);
  78         f->fullname = path_join(f, dir, f->name);
  79         f->contents = NULL;
  80         f->simplified = NULL;
  81         return f;
  82 }
  83
  84 static void add_files(struct manifest *m, const char *base, const char *subdir)
  85 {
  86         DIR *d;
  87         struct dirent *ent;
  88         char **subs = tal_arr(m, char *, 0);
  89         const char *thisdir;
  90
  91         if (!subdir)
  92                 thisdir = base;
  93         else
  94                 thisdir = path_join(subs, base, subdir);
  95
  96         d = opendir(thisdir);
  97         if (!d)
  98                 err(1, "Opening directory %s", thisdir);
  99
 100         while ((ent = readdir(d)) != NULL) {
 101                 struct stat st;
 102                 struct ccan_file *f;
 103                 struct list_head *dest;
 104                 bool is_c_src;
 105
 106                 if (ent->d_name[0] == '.')
 107                         continue;
 108
 109                 f = new_ccan_file(m, m->dir,
 110                                   subdir ? path_join(m, subdir, ent->d_name)
 111                                   : ent->d_name);
 112                 if (lstat(f->fullname, &st) != 0)
 113                         err(1, "lstat %s", f->fullname);
 114
 115                 if (S_ISDIR(st.st_mode)) {
 116                         size_t len = tal_count(subs);
 117                         tal_resize(&subs, len+1);
 118                         subs[len] = tal_strcat(subs, f->name, "/");
 119                         continue;
 120                 }
 121                 if (!S_ISREG(st.st_mode)) {
 122                         tal_free(f);
 123                         continue;
 124                 }
 125
 126                 if (streq(f->name, "_info")) {
 127                         m->info_file = f;
 128                         continue;
 129                 }
 130
 131                 is_c_src = strends(f->name, ".c");
 132                 if (!is_c_src && !strends(f->name, ".h")) {
 133                         dest = &m->other_files;
 134                 } else if (!strchr(f->name, '/')) {
 135                         if (is_c_src)
 136                                 dest = &m->c_files;
 137                         else
 138                                 dest = &m->h_files;
 139                 } else if (strstarts(f->name, "test/")) {
 140                         if (is_c_src) {
 141                                 if (strstarts(f->name, "test/api"))
 142                                         dest = &m->api_tests;
 143                                 else if (strstarts(f->name, "test/run"))
 144                                         dest = &m->run_tests;
 145                                 else if (strstarts(f->name, "test/compile_ok"))
 146                                         dest = &m->compile_ok_tests;
 147                                 else if (strstarts(f->name, "test/compile_fail"))
 148                                         dest = &m->compile_fail_tests;
 149                                 else
 150                                         dest = &m->other_test_c_files;
 151                         } else
 152                                 dest = &m->other_test_files;
 153                 } else
 154                         dest = &m->other_files;
 155
 156                 list_add(dest, &f->list);
 157         }
 158         closedir(d);
 159
 160         /* Before we recurse, sanity check this is a ccan module. */
 161         if (!subdir) {
 162                 size_t i;
 163
 164                 if (!m->info_file
 165                     && list_empty(&m->c_files)
 166                     && list_empty(&m->h_files))
 167                         errx(1, "No _info, C or H files found here!");
 168
 169                 for (i = 0; i < tal_count(subs); i++)
 170                         add_files(m, base, subs[i]);
 171         }
 172         tal_free(subs);
 173 }
 174
 175 static int cmp_names(struct ccan_file *const *a, struct ccan_file *const *b,
 176                      void *unused)
 177 {
 178         return strcmp((*a)->name, (*b)->name);
 179 }
 180
 181 static void sort_files(struct list_head *list)
 182 {
 183         struct ccan_file **files = tal_arr(NULL, struct ccan_file *, 0), *f;
 184         unsigned int i;
 185
 186         while ((f = list_top(list, struct ccan_file, list)) != NULL) {
 187                 tal_expand(&files, &f, 1);
 188                 list_del(&f->list);
 189         }
 190         asort(files, tal_count(files), cmp_names, NULL);
 191
 192         for (i = 0; i < tal_count(files); i++)
 193                 list_add_tail(list, &files[i]->list);
 194         tal_free(files);
 195 }
 196
 197 struct manifest *get_manifest(const void *ctx, const char *dir)
 198 {
 199         struct manifest *m;
 200         char *canon_dir;
 201         unsigned int len;
 202         struct list_head *list;
 203
 204         if (!manifests) {
 205                 manifests = tal(NULL, struct htable_manifest);
 206                 htable_manifest_init(manifests);
 207         }
 208
 209         canon_dir = path_canon(ctx, dir);
 210         if (!canon_dir)
 211                 err(1, "Getting canonical version of directory %s", dir);
 212
 213         m = htable_manifest_get(manifests, canon_dir);
 214         if (m)
 215                 return m;
 216
 217         m = tal_linkable(tal(NULL, struct manifest));
 218         m->info_file = NULL;
 219         m->compiled[COMPILE_NORMAL] = m->compiled[COMPILE_NOFEAT] = NULL;
 220         m->dir = tal_steal(m, canon_dir);
 221         list_head_init(&m->c_files);
 222         list_head_init(&m->h_files);
 223         list_head_init(&m->api_tests);
 224         list_head_init(&m->run_tests);
 225         list_head_init(&m->compile_ok_tests);
 226         list_head_init(&m->compile_fail_tests);
 227         list_head_init(&m->other_test_c_files);
 228         list_head_init(&m->other_test_files);
 229         list_head_init(&m->other_files);
 230         list_head_init(&m->examples);
 231         list_head_init(&m->mangled_examples);
 232         list_head_init(&m->deps);
 233         list_head_init(&m->test_deps);
 234
 235         /* Trim trailing /. */
 236         len = strlen(m->dir);
 237         while (len && m->dir[len-1] == '/')
 238                 m->dir[--len] = '\0';
 239
 240         m->basename = strrchr(m->dir, '/');
 241         if (!m->basename)
 242                 errx(1, "I don't expect to be run from the root directory");
 243         m->basename++;
 244
 245         assert(strstarts(m->dir, find_ccan_dir(m->dir)));
 246         m->modname = m->dir + strlen(find_ccan_dir(m->dir)) + strlen("ccan/");
 247
 248         add_files(m, canon_dir, NULL);
 249
 250         /* Nicer to run tests in a predictable order. */
 251         foreach_ptr(list, &m->api_tests, &m->run_tests, &m->compile_ok_tests,
 252                     &m->compile_fail_tests)
 253                 sort_files(list);
 254
 255         htable_manifest_add(manifests, tal_link(manifests, m));
 256
 257         return m;
 258 }