ccanlint: Add -k option to keep results.
[ccan] / tools / tools.h
1 #ifndef CCAN_TOOLS_H
2 #define CCAN_TOOLS_H
3 #include <stdbool.h>
4
5 #define IDENT_CHARS     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
6                         "abcdefghijklmnopqrstuvwxyz" \
7                         "01234567889_"
8
9 #define SPACE_CHARS     " \f\n\r\t\v"
10
11 /* FIXME: Nested functions break with -Wmissing-prototypes -Wmissing-declarations */
12 #define CFLAGS "-g -Wall -Wundef -Wstrict-prototypes -Wold-style-definition -Werror -I../.."
13
14 /* This actually compiles and runs the info file to get dependencies. */
15 char **get_deps(const void *ctx, const char *dir, bool recurse,
16                 char **infofile);
17
18 /* This is safer: just looks for ccan/ strings in info */
19 char **get_safe_ccan_deps(const void *ctx, const char *dir,
20                           bool recurse, char **infofile);
21
22 /* This also needs to compile the info file. */
23 char **get_libs(const void *ctx, const char *dir,
24                 unsigned int *num, char **infofile);
25
26 /* From tools.c */
27 char *talloc_basename(const void *ctx, const char *dir);
28 char *talloc_dirname(const void *ctx, const char *dir);
29 char *talloc_getcwd(const void *ctx);
30 char *run_command(const void *ctx, unsigned int *time_ms, const char *fmt, ...);
31 char *temp_file(const void *ctx, const char *extension);
32 bool move_file(const char *oldname, const char *newname);
33
34 /* From compile.c.
35  *
36  * These all compile into a temporary dir, and return the filename.
37  * On failure they return NULL, and errmsg is set to compiler output.
38  */
39 /* Compile multiple object files into a single. */
40 char *link_objects(const void *ctx, const char *objs, char **errmsg);
41 /* Compile a single C file to an object file.  Returns errmsg if fails. */
42 char *compile_object(const void *ctx, const char *cfile, const char *ccandir,
43                      const char *outfile);
44 /* Compile and link single C file, with object files, libs, etc.  NULL on
45  * success, error output on fail. */
46 char *compile_and_link(const void *ctx, const char *cfile, const char *ccandir,
47                        const char *objs, const char *extra_cflags,
48                        const char *libs, const char *outfile);
49
50 /* If keep is false, return a temporary file.  Otherwise, base it on srcname */
51 char *maybe_temp_file(const void *ctx, const char *extension, bool keep,
52                       const char *srcname);
53
54 /* Default wait for run_command.  Should never time out. */
55 extern const unsigned int default_timeout_ms;
56
57 #endif /* CCAN_TOOLS_H */