git.ozlabs.org Git - ccan/blob - 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"
  13
  14 #define COVERAGE_CFLAGS "-fprofile-arcs -ftest-coverage"
  15
  16 /* This actually compiles and runs the info file to get dependencies. */
  17 char **get_deps(const void *ctx, const char *dir, bool recurse,
  18                 char **infofile);
  19
  20 /* This is safer: just looks for ccan/ strings in info */
  21 char **get_safe_ccan_deps(const void *ctx, const char *dir,
  22                           bool recurse, char **infofile);
  23
  24 /* This also needs to compile the info file. */
  25 char **get_libs(const void *ctx, const char *dir,
  26                 unsigned int *num, char **infofile);
  27
  28 /* From tools.c */
  29 char *talloc_basename(const void *ctx, const char *dir);
  30 char *talloc_dirname(const void *ctx, const char *dir);
  31 char *talloc_getcwd(const void *ctx);
  32 char *run_command(const void *ctx, unsigned int *time_ms, const char *fmt, ...);
  33 char *run_with_timeout(const void *ctx, const char *cmd,
  34                        bool *ok, unsigned *timeout_ms);
  35 char *temp_file(const void *ctx, const char *extension);
  36 bool move_file(const char *oldname, const char *newname);
  37
  38 /* From compile.c.
  39  *
  40  * These all compile into a temporary dir, and return the filename.
  41  * On failure they return NULL, and errmsg is set to compiler output.
  42  */
  43 /* Compile multiple object files into a single. */
  44 char *link_objects(const void *ctx, const char *objs, char **errmsg);
  45 /* Compile a single C file to an object file.  Returns errmsg if fails. */
  46 char *compile_object(const void *ctx, const char *cfile, const char *ccandir,
  47                      const char *extra_cflags,
  48                      const char *outfile);
  49 /* Compile and link single C file, with object files, libs, etc.  NULL on
  50  * success, error output on fail. */
  51 char *compile_and_link(const void *ctx, const char *cfile, const char *ccandir,
  52                        const char *objs, const char *extra_cflags,
  53                        const char *libs, const char *outfile);
  54
  55 /* If keep is false, return a temporary file.  Otherwise, base it on srcname */
  56 char *maybe_temp_file(const void *ctx, const char *extension, bool keep,
  57                       const char *srcname);
  58
  59 /* Default wait for run_command.  Should never time out. */
  60 extern const unsigned int default_timeout_ms;
  61
  62 #endif /* CCAN_TOOLS_H */