git.ozlabs.org Git - ccan/blob - tools/tools.h

   1 #ifndef CCAN_TOOLS_H
   2 #define CCAN_TOOLS_H
   3 #include "config.h"
   4 #include <ccan/compiler/compiler.h>
   5 #include <ccan/rbuf/rbuf.h>
   6 #include <ccan/tal/tal.h>
   7 #include <ccan/tal/str/str.h>
   8 #include <stdlib.h>
   9 #include <stdbool.h>
  10
  11 /* These are the defaults. */
  12 #define DEFAULT_CCAN_COMPILER "cc"
  13 #define DEFAULT_CCAN_CFLAGS "-g"
  14
  15 #define IDENT_CHARS     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
  16                         "abcdefghijklmnopqrstuvwxyz" \
  17                         "01234567889_"
  18
  19 #define SPACE_CHARS     " \f\n\r\t\v"
  20
  21 #define COVERAGE_CFLAGS "-fprofile-arcs -ftest-coverage"
  22
  23 /* Actual compiler and cflags (defaults to CCAN_COMPILER and CCAN_CFLAGS). */
  24 extern const char *compiler, *cflags;
  25
  26 /* This compiles up the _info file into a temporary. */
  27 char *compile_info(const void *ctx, const char *dir);
  28
  29 /* This actually compiles and runs the info file to get dependencies. */
  30 char **get_deps(const void *ctx, const char *dir, const char *style,
  31                 bool recurse,
  32                 char *(*get_info)(const void *ctx, const char *dir));
  33
  34 /* This is safer: just looks for ccan/ strings in info */
  35 char **get_safe_ccan_deps(const void *ctx, const char *dir, const char *style,
  36                           bool recurse);
  37
  38 /* This also needs to compile the info file:
  39  * style == NULL: don't recurse.
  40  * style == depends: recurse dependencies.
  41  * style == testdepends: recurse testdepends and depends.
  42  */
  43 char **get_libs(const void *ctx, const char *dir, const char *style,
  44                 char *(*get_info)(const void *ctx, const char *dir));
  45
  46 char **get_cflags(const void *ctx, const char *dir,
  47                 char *(*get_info)(const void *ctx, const char *dir));
  48
  49 char *get_ported(const void *ctx, const char *dir, bool recurse,
  50                  char *(*get_info)(const void *ctx, const char *dir));
  51
  52 /* From tools.c */
  53 /* If set, print all commands run, all output they give and exit status. */
  54 extern bool tools_verbose;
  55 bool PRINTF_FMT(4,5) run_command(const void *ctx,
  56                                  unsigned int *time_ms,
  57                                  char **output,
  58                                  const char *fmt, ...);
  59 char *run_with_timeout(const void *ctx, const char *cmd,
  60                        bool *ok, unsigned *timeout_ms);
  61 const char *temp_dir(void);
  62 void keep_temp_dir(void);
  63 bool move_file(const char *oldname, const char *newname);
  64
  65 void *do_tal_realloc(void *p, size_t size);
  66
  67 /* Freed on exit: a good parent for auto cleanup. */
  68 tal_t *autofree(void);
  69
  70 /* From compile.c.
  71  *
  72  * These all compile into a temporary dir, and return the filename.
  73  * On failure they return NULL, and errmsg is set to compiler output.
  74  */
  75 /* If set, say what we're compiling to. */
  76 extern bool compile_verbose;
  77 /* Compile multiple object files into a single. */
  78 char *link_objects(const void *ctx, const char *basename,
  79                    const char *objs, char **errmsg);
  80 /* Compile a single C file to an object file.  Returns false if fails. */
  81 bool compile_object(const void *ctx, const char *cfile, const char *ccandir,
  82                     const char *compiler,
  83                     const char *cflags,
  84                     const char *outfile, char **output);
  85 /* Compile and link single C file, with object files, libs, etc. */
  86 bool compile_and_link(const void *ctx, const char *cfile, const char *ccandir,
  87                       const char *objs,
  88                       const char *compiler, const char *cflags,
  89                       const char *libs, const char *outfile, char **output);
  90
  91 /* Returns a file in temp_dir() */
  92 char *temp_file(const void *ctx, const char *extension, const char *srcname);
  93
  94 /* Default wait for run_command.  Should never time out. */
  95 extern const unsigned int default_timeout_ms;
  96
  97 /* Get ccan/ top dir, given a directory within it. */
  98 const char *find_ccan_dir(const char *base);
  99 #endif /* CCAN_TOOLS_H */