tdb2: unify tdb1_transaction_start etc. into tdb_transaction_start.
[ccan] / tools / tools.h
1 #ifndef CCAN_TOOLS_H
2 #define CCAN_TOOLS_H
3 #include <stdbool.h>
4 #include <ccan/compiler/compiler.h>
5 #include "config.h"
6
7 #ifndef CCAN_COMPILER
8 #define CCAN_COMPILER "cc"
9 #endif
10 #ifndef CCAN_CFLAGS
11 #define CCAN_CFLAGS "-g -Wall -Wundef -Wmissing-prototypes -Wmissing-declarations -Wstrict-prototypes -Wold-style-definition -Werror"
12 #endif
13
14 #define IDENT_CHARS     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
15                         "abcdefghijklmnopqrstuvwxyz" \
16                         "01234567889_"
17
18 #define SPACE_CHARS     " \f\n\r\t\v"
19
20 #define COVERAGE_CFLAGS "-fprofile-arcs -ftest-coverage"
21
22 /* This actually compiles and runs the info file to get dependencies. */
23 char **get_deps(const void *ctx, const char *dir, bool recurse,
24                 char **infofile);
25
26 /* This is safer: just looks for ccan/ strings in info */
27 char **get_safe_ccan_deps(const void *ctx, const char *dir, bool recurse);
28
29 /* This also needs to compile the info file. */
30 char **get_libs(const void *ctx, const char *dir,
31                 unsigned int *num, char **infofile);
32
33 /* From tools.c */
34 /* If set, print all commands run, all output they give and exit status. */
35 extern bool tools_verbose;
36 char *talloc_basename(const void *ctx, const char *dir);
37 char *talloc_dirname(const void *ctx, const char *dir);
38 char *talloc_getcwd(const void *ctx);
39 bool PRINTF_FMT(4,5) run_command(const void *ctx,
40                                  unsigned int *time_ms,
41                                  char **output,
42                                  const char *fmt, ...);
43 char *run_with_timeout(const void *ctx, const char *cmd,
44                        bool *ok, unsigned *timeout_ms);
45 const char *temp_dir(const void *ctx);
46 bool move_file(const char *oldname, const char *newname);
47
48 /* From compile.c.
49  *
50  * These all compile into a temporary dir, and return the filename.
51  * On failure they return NULL, and errmsg is set to compiler output.
52  */
53 /* If set, say what we're compiling to. */
54 extern bool compile_verbose;
55 /* Compile multiple object files into a single. */
56 char *link_objects(const void *ctx, const char *basename, bool in_pwd,
57                    const char *objs, char **errmsg);
58 /* Compile a single C file to an object file.  Returns false if fails. */
59 bool compile_object(const void *ctx, const char *cfile, const char *ccandir,
60                     const char *compiler,
61                     const char *cflags,
62                     const char *outfile, char **output);
63 /* Compile and link single C file, with object files, libs, etc. */
64 bool compile_and_link(const void *ctx, const char *cfile, const char *ccandir,
65                       const char *objs,
66                       const char *compiler, const char *cflags,
67                       const char *libs, const char *outfile, char **output);
68
69 /* If in_pwd is false, return a file int temp_dir, otherwise a local file. */
70 char *maybe_temp_file(const void *ctx, const char *extension, bool in_pwd,
71                       const char *srcname);
72
73 /* Default wait for run_command.  Should never time out. */
74 extern const unsigned int default_timeout_ms;
75
76 /* Talloc destructor which unlinks file. */
77 int unlink_file_destructor(char *filename);
78
79 #endif /* CCAN_TOOLS_H */