ccanlint: -k should not pollute module directory.
[ccan] / tools / tools.h
index e43643ddb4d2028ffe1f3f9f9a9b018204876259..a4c4cfa06b8f3bd79ff3b5e7ed274143b8634c51 100644 (file)
@@ -1,13 +1,78 @@
 #ifndef CCAN_TOOLS_H
 #define CCAN_TOOLS_H
+#include <stdbool.h>
+#include <ccan/compiler/compiler.h>
+#include "config.h"
 
-#define CFLAGS "-O3 -Wall -Wundef -Wstrict-prototypes -Wold-style-definition -Wmissing-prototypes -Wmissing-declarations -Werror -Iccan/ -I."
+#ifndef CCAN_COMPILER
+#define CCAN_COMPILER "cc"
+#endif
+#ifndef CCAN_CFLAGS
+#define CCAN_CFLAGS "-g -Wall -Wundef -Wmissing-prototypes -Wmissing-declarations -Wstrict-prototypes -Wold-style-definition -Werror"
+#endif
 
-/* This actually compiles and runs the _info.c file to get dependencies. */
-char **get_deps(const void *ctx, const char *dir);
+#define IDENT_CHARS    "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
+                       "abcdefghijklmnopqrstuvwxyz" \
+                       "01234567889_"
 
-/* This is safer: just looks for ccan/ strings in _info.c */
-char **get_safe_ccan_deps(const void *ctx, const char *dir);
+#define SPACE_CHARS    " \f\n\r\t\v"
 
-#endif /* CCAN_TOOLS_H */
+#define COVERAGE_CFLAGS "-fprofile-arcs -ftest-coverage"
+
+/* This actually compiles and runs the info file to get dependencies. */
+char **get_deps(const void *ctx, const char *dir, bool recurse,
+               char **infofile);
+
+/* This is safer: just looks for ccan/ strings in info */
+char **get_safe_ccan_deps(const void *ctx, const char *dir,
+                         bool recurse, char **infofile);
+
+/* This also needs to compile the info file. */
+char **get_libs(const void *ctx, const char *dir,
+               unsigned int *num, char **infofile);
+
+/* From tools.c */
+/* If set, print all commands run, all output they give and exit status. */
+extern bool tools_verbose;
+char *talloc_basename(const void *ctx, const char *dir);
+char *talloc_dirname(const void *ctx, const char *dir);
+char *talloc_getcwd(const void *ctx);
+bool PRINTF_FMT(4,5) run_command(const void *ctx,
+                                unsigned int *time_ms,
+                                char **output,
+                                const char *fmt, ...);
+char *run_with_timeout(const void *ctx, const char *cmd,
+                      bool *ok, unsigned *timeout_ms);
+char *temp_dir(const void *ctx);
+bool move_file(const char *oldname, const char *newname);
 
+/* From compile.c.
+ *
+ * These all compile into a temporary dir, and return the filename.
+ * On failure they return NULL, and errmsg is set to compiler output.
+ */
+/* If set, say what we're compiling to. */
+extern bool compile_verbose;
+/* Compile multiple object files into a single. */
+char *link_objects(const void *ctx, const char *basename, bool in_pwd,
+                  const char *objs, char **errmsg);
+/* Compile a single C file to an object file.  Returns false if fails. */
+bool compile_object(const void *ctx, const char *cfile, const char *ccandir,
+                   const char *extra_cflags,
+                   const char *outfile, char **output);
+/* Compile and link single C file, with object files, libs, etc. */
+bool compile_and_link(const void *ctx, const char *cfile, const char *ccandir,
+                     const char *objs, const char *extra_cflags,
+                     const char *libs, const char *outfile, char **output);
+
+/* If in_pwd is false, return a file int temp_dir, otherwise a local file. */
+char *maybe_temp_file(const void *ctx, const char *extension, bool in_pwd,
+                     const char *srcname);
+
+/* Default wait for run_command.  Should never time out. */
+extern const unsigned int default_timeout_ms;
+
+/* Talloc destructor which unlinks file. */
+int unlink_file_destructor(char *filename);
+
+#endif /* CCAN_TOOLS_H */