ccanlint: remove redundant num_lines in struct ccan_file.
[ccan] / 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, char *name)
64 {
65         struct ccan_file *f;
66         unsigned int i;
67
68         assert(dir[0] == '/');
69
70         f = tal(ctx, struct ccan_file);
71         f->lines = NULL;
72         f->line_info = NULL;
73         f->doc_sections = NULL;
74         for (i = 0; i < ARRAY_SIZE(f->compiled); i++)
75                 f->compiled[i] = NULL;
76         f->name = tal_steal(f, name);
77         f->fullname = path_join(f, dir, f->name);
78         f->contents = NULL;
79         f->simplified = NULL;
80         return f;
81 }
82
83 static void add_files(struct manifest *m, const char *dir)
84 {
85         DIR *d;
86         struct dirent *ent;
87         char **subs = tal_arr(m, char *, 0);
88
89         if (dir[0])
90                 d = opendir(dir);
91         else
92                 d = opendir(".");
93         if (!d)
94                 err(1, "Opening directory %s", dir[0] ? dir : ".");
95
96         while ((ent = readdir(d)) != NULL) {
97                 struct stat st;
98                 struct ccan_file *f;
99                 struct list_head *dest;
100                 bool is_c_src;
101
102                 if (ent->d_name[0] == '.')
103                         continue;
104
105                 f = new_ccan_file(m, m->dir,
106                                   tal_fmt(m, "%s%s", dir, ent->d_name));
107                 if (lstat(f->name, &st) != 0)
108                         err(1, "lstat %s", f->name);
109
110                 if (S_ISDIR(st.st_mode)) {
111                         size_t len = tal_count(subs);
112                         tal_resize(&subs, len+1);
113                         subs[len] = tal_strcat(subs, f->name, "/");
114                         continue;
115                 }
116                 if (!S_ISREG(st.st_mode)) {
117                         tal_free(f);
118                         continue;
119                 }
120
121                 if (streq(f->name, "_info")) {
122                         m->info_file = f;
123                         continue;
124                 }
125
126                 is_c_src = strends(f->name, ".c");
127                 if (!is_c_src && !strends(f->name, ".h")) {
128                         dest = &m->other_files;
129                 } else if (!strchr(f->name, '/')) {
130                         if (is_c_src)
131                                 dest = &m->c_files;
132                         else
133                                 dest = &m->h_files;
134                 } else if (strstarts(f->name, "test/")) {
135                         if (is_c_src) {
136                                 if (strstarts(f->name, "test/api"))
137                                         dest = &m->api_tests;
138                                 else if (strstarts(f->name, "test/run"))
139                                         dest = &m->run_tests;
140                                 else if (strstarts(f->name, "test/compile_ok"))
141                                         dest = &m->compile_ok_tests;
142                                 else if (strstarts(f->name, "test/compile_fail"))
143                                         dest = &m->compile_fail_tests;
144                                 else
145                                         dest = &m->other_test_c_files;
146                         } else
147                                 dest = &m->other_test_files;
148                 } else
149                         dest = &m->other_files;
150
151                 list_add(dest, &f->list);
152         }
153         closedir(d);
154
155         /* Before we recurse, sanity check this is a ccan module. */
156         if (!dir[0]) {
157                 size_t i;
158
159                 if (!m->info_file
160                     && list_empty(&m->c_files)
161                     && list_empty(&m->h_files))
162                         errx(1, "No _info, C or H files found here!");
163
164                 for (i = 0; i < tal_count(subs); i++)
165                         add_files(m, subs[i]);
166         }
167         tal_free(subs);
168 }
169
170 static int cmp_names(struct ccan_file *const *a, struct ccan_file *const *b,
171                      void *unused)
172 {
173         return strcmp((*a)->name, (*b)->name);
174 }
175
176 static void sort_files(struct list_head *list)
177 {
178         struct ccan_file **files = tal_arr(NULL, struct ccan_file *, 0), *f;
179         unsigned int i;
180
181         while ((f = list_top(list, struct ccan_file, list)) != NULL) {
182                 tal_expand(&files, &f, 1);
183                 list_del(&f->list);
184         }
185         asort(files, tal_count(files), cmp_names, NULL);
186
187         for (i = 0; i < tal_count(files); i++)
188                 list_add_tail(list, &files[i]->list);
189         tal_free(files);
190 }
191
192 struct manifest *get_manifest(const void *ctx, const char *dir)
193 {
194         struct manifest *m;
195         char *canon_dir;
196         unsigned int len;
197         struct list_head *list;
198         struct path_pushd *old;
199
200         if (!manifests) {
201                 manifests = tal(NULL, struct htable_manifest);
202                 htable_manifest_init(manifests);
203         }
204
205         /* FIXME: Use path_canon, don't chdir! */
206         old = path_pushd(ctx, dir);
207         if (!old)
208                 err(1, "Failed to chdir to %s", dir);
209
210         canon_dir = path_cwd(old);
211         if (!canon_dir)
212                 err(1, "Getting current directory");
213
214         m = htable_manifest_get(manifests, canon_dir);
215         if (m)
216                 goto done;
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, "");
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 done:
258         if (!path_popd(old))
259                 err(1, "Returning to original directory");
260
261         return m;
262 }