doc: english fixup.
[ccan] / tools / depends.c
1 #include <ccan/str/str.h>
2 #include <ccan/read_write_all/read_write_all.h>
3 #include <ccan/rbuf/rbuf.h>
4 #include <ccan/tal/path/path.h>
5 #include <ccan/tal/grab_file/grab_file.h>
6 #include <ccan/compiler/compiler.h>
7 #include <ccan/err/err.h>
8 #include "tools.h"
9 #include <sys/types.h>
10 #include <sys/stat.h>
11 #include <fcntl.h>
12 #include <stdbool.h>
13 #include <unistd.h>
14 #include <errno.h>
15
16 static char ** PRINTF_FMT(2, 3)
17 lines_from_cmd(const void *ctx, const char *format, ...)
18 {
19         va_list ap;
20         char *cmd;
21         FILE *p;
22         struct rbuf in;
23
24         va_start(ap, format);
25         cmd = tal_vfmt(ctx, format, ap);
26         va_end(ap);
27
28         p = popen(cmd, "r");
29         if (!p)
30                 err(1, "Executing '%s'", cmd);
31
32         /* FIXME: Use rbuf_read_str(&in, '\n') rather than strsplit! */
33         rbuf_init(&in, fileno(p), tal_arr(ctx, char, 0), 0);
34         if (!rbuf_read_str(&in, 0, do_tal_realloc) && errno)
35                 err(1, "Reading from '%s'", cmd);
36         pclose(p);
37
38         return tal_strsplit(ctx, in.buf, "\n", STR_EMPTY_OK);
39 }
40
41 /* Be careful about trying to compile over running programs (parallel make).
42  * temp_file helps here. */
43 char *compile_info(const void *ctx, const char *dir)
44 {
45         char *info_c_file, *info, *compiled, *output;
46         int fd;
47
48         /* Copy it to a file with proper .c suffix. */
49         info = grab_file(ctx, tal_fmt(ctx, "%s/_info", dir));
50         if (!info)
51                 return NULL;
52
53         info_c_file = temp_file(ctx, ".c", "_info");
54         fd = open(info_c_file, O_WRONLY|O_CREAT|O_EXCL, 0600);
55         if (fd < 0)
56                 return NULL;
57         if (!write_all(fd, info, tal_count(info)-1))
58                 return NULL;
59
60         if (close(fd) != 0)
61                 return NULL;
62
63         compiled = temp_file(ctx, "", "info");
64         if (compile_and_link(ctx, info_c_file, find_ccan_dir(dir), "",
65                              compiler, cflags, "", compiled, &output))
66                 return compiled;
67         return NULL;
68 }
69
70 static char **get_one_deps(const void *ctx, const char *dir, const char *style,
71                            char *(*get_info)(const void *ctx, const char *dir))
72 {
73         char **deps, *cmd;
74         char *infofile = get_info(ctx, dir);
75
76         if (!infofile)
77                 return NULL;
78
79         cmd = tal_fmt(ctx, "%s %s", infofile, style);
80         deps = lines_from_cmd(cmd, "%s", cmd);
81         if (!deps) {
82                 /* You must understand depends, maybe not testdepends. */
83                 if (streq(style, "depends"))
84                         err(1, "Could not run '%s'", cmd);
85                 deps = tal(ctx, char *);
86                 deps[0] = NULL;
87         }
88         return deps;
89 }
90
91 /* Make copy of src, replacing "from" with "to". */
92 static char *replace(const void *ctx, const char *src,
93                      const char *from, const char *to)
94 {
95         char *ret = tal_strdup(ctx, "");
96         unsigned int rlen, len, add;
97
98         rlen = len = 0;
99         for (;;) {
100                 const char *next = strstr(src+len, from);
101                 if (!next)
102                         add = strlen(src+len) + 1;
103                 else
104                         add = next - (src+len);
105
106                 tal_resize(&ret, rlen + add + strlen(to)+1);
107                 memcpy(ret+rlen, src+len, add);
108                 if (!next)
109                         return ret;
110                 len += add;
111                 rlen += add;
112                 strcpy(ret+rlen, to);
113                 rlen += strlen(to);
114                 len += strlen(from);
115         }
116 }
117
118 /* This is a terrible hack.  We scan for ccan/ strings. */
119 static char **get_one_safe_deps(const void *ctx,
120                                 const char *dir,
121                                 const char *style,
122                                 char *(*unused)(const void *, const char *))
123 {
124         char **deps, **lines, *raw, *fname;
125         unsigned int i, n;
126         bool correct_style = false;
127
128         fname = path_join(ctx, dir, "_info");
129         raw = grab_file(fname, fname);
130         if (!raw)
131                 errx(1, "Could not open %s", fname);
132
133         /* Replace \n by actual line breaks, and split it. */
134         lines = tal_strsplit(raw, replace(raw, raw, "\\n", "\n"), "\n",
135                              STR_EMPTY_OK);
136
137         deps = tal_arr(ctx, char *, tal_count(lines));
138
139         for (n = i = 0; lines[i]; i++) {
140                 char *str;
141                 unsigned int len;
142
143                 /* Ignore lines starting with # (e.g. #include) */
144                 if (lines[i][0] == '#')
145                         continue;
146
147                 if (strstr(lines[i], "\"testdepends\""))
148                         correct_style = streq(style, "testdepends");
149                 else if (strstr(lines[i], "\"depends\""))
150                         correct_style = streq(style, "depends");
151
152                 if (!correct_style)
153                         continue;
154
155                 /* Start of line, or after ". */
156                 if (strstarts(lines[i], "ccan/"))
157                         str = lines[i];
158                 else {
159                         str = strstr(lines[i], "\"ccan/");
160                         if (!str)
161                                 continue;
162                         str++;
163                 }
164                 
165                 len = strspn(str, "/abcdefghijklmnopqrstuvxwyz12345678980_");
166                 if (len == 5)
167                         continue;
168                 deps[n++] = tal_strndup(deps, str, len);
169         }
170         deps[n] = NULL;
171         tal_free(fname);
172
173         /* Make sure tal_array_length() works */
174         tal_resize(&deps, n + 1);
175         return deps;
176 }
177
178 static bool have_dep(char **deps, const char *dep)
179 {
180         unsigned int i;
181
182         for (i = 0; deps[i]; i++)
183                 if (streq(deps[i], dep))
184                         return true;
185         return false;
186 }
187
188
189
190 /* Gets all the dependencies, recursively. */
191 static char **
192 get_all_deps(const void *ctx, const char *dir, const char *style,
193              char *(*get_info)(const void *ctx, const char *dir),
194              char **(*get_one)(const void *, const char *, const char *,
195                                char *(*get_info)(const void *, const char *)))
196 {
197         char **deps;
198         unsigned int i;
199
200         deps = get_one(ctx, dir, style, get_info);
201         if (!deps)
202                 return NULL;
203         for (i = 0; i < tal_count(deps)-1; i++) {
204                 char **newdeps;
205                 unsigned int j;
206                 char *subdir;
207
208                 if (!strstarts(deps[i], "ccan/"))
209                         continue;
210
211                 subdir = path_join(ctx, find_ccan_dir(dir), deps[i]);
212                 newdeps = get_one(ctx, subdir, "depends", get_info);
213
214                 /* Should be short, so brute-force out dups. */
215                 for (j = 0; j < tal_count(newdeps)-1; j++) {
216                         unsigned int num;
217
218                         if (have_dep(deps, newdeps[j]))
219                                 continue;
220
221                         num = tal_count(deps)-1;
222                         tal_resize(&deps, num + 2);
223                         deps[num] = newdeps[j];
224                         deps[num+1] = NULL;
225                 }
226         }
227         return deps;
228 }
229
230 /* Can return NULL: _info may not support 'libs'. */
231 static char **get_one_libs(const void *ctx, const char *dir,
232                            char *(*get_info)(const void *ctx, const char *dir))
233 {
234         char *cmd, **lines;
235
236         cmd = tal_fmt(ctx, "%s libs", get_info(ctx, dir));
237         lines = lines_from_cmd(cmd, "%s", cmd);
238         /* Strip final NULL. */
239         if (lines)
240                 tal_resize(&lines, tal_count(lines)-1);
241         return lines;
242 }
243
244 /* O(n^2) but n is small. */
245 static char **add_deps(char **deps1, char **deps2)
246 {
247         unsigned int i, len;
248
249         len = tal_count(deps1);
250
251         for (i = 0; deps2[i]; i++) {
252                 if (have_dep(deps1, deps2[i]))
253                         continue;
254                 tal_resize(&deps1, len + 1);
255                 deps1[len-1] = tal_strdup(deps1, deps2[i]);
256                 deps1[len++] = NULL;
257         }
258         return deps1;
259 }
260
261 char **get_libs(const void *ctx, const char *dir, const char *style,
262                 char *(*get_info)(const void *ctx, const char *dir))
263 {
264         char **deps, **libs;
265         unsigned int i, len;
266
267         libs = get_one_libs(ctx, dir, get_info);
268         len = tal_count(libs);
269
270         if (style) {
271                 deps = get_deps(ctx, dir, style, true, get_info);
272                 if (streq(style, "testdepends"))
273                         deps = add_deps(deps,
274                                         get_deps(ctx, dir, "depends", true,
275                                                  get_info));
276
277                 for (i = 0; deps[i]; i++) {
278                         char **newlibs, *subdir;
279                         size_t newlen;
280
281                         if (!strstarts(deps[i], "ccan/"))
282                                 continue;
283
284                         subdir = path_join(ctx, find_ccan_dir(dir), deps[i]);
285
286                         newlibs = get_one_libs(ctx, subdir, get_info);
287                         newlen = tal_count(newlibs);
288                         tal_resize(&libs, len + newlen);
289                         memcpy(&libs[len], newlibs,
290                                sizeof(newlibs[0])*newlen);
291                         len += newlen;
292                 }
293         }
294
295         /* Append NULL entry. */
296         tal_resize(&libs, len + 1);
297         libs[len] = NULL;
298         return libs;
299 }
300
301 /* FIXME: This is O(n^2), which is dumb. */
302 static char **uniquify_deps(char **deps)
303 {
304         unsigned int i, j, num;
305
306         if (!deps)
307                 return NULL;
308
309         num = tal_count(deps) - 1;
310         for (i = 0; i < num; i++) {
311                 for (j = i + 1; j < num; j++) {
312                         if (streq(deps[i], deps[j])) {
313                                 memmove(&deps[j], &deps[j+1],
314                                         (num - j - 1) * sizeof(char *));
315                                 num--;
316                         }
317                 }
318         }
319         deps[num] = NULL;
320         /* Make sure tal_count() works */
321         tal_resize(&deps, num + 1);
322         return deps;
323 }
324
325 char **get_deps(const void *ctx, const char *dir, const char *style,
326                 bool recurse,
327                 char *(*get_info)(const void *ctx, const char *dir))
328 {
329         char **ret;
330
331         if (!recurse) {
332                 ret = get_one_deps(ctx, dir, style, get_info);
333         } else
334                 ret = get_all_deps(ctx, dir, style, get_info, get_one_deps);
335
336         return uniquify_deps(ret);
337 }
338
339 char **get_safe_ccan_deps(const void *ctx, const char *dir, const char *style,
340                           bool recurse)
341 {
342         char **ret;
343         if (!recurse) {
344                 ret = get_one_safe_deps(ctx, dir, style, NULL);
345         } else {
346                 ret = get_all_deps(ctx, dir, style, NULL, get_one_safe_deps);
347         }
348         return uniquify_deps(ret);
349 }