CBuild wiki

Compile.h

Some helpers specifically for a compilation

License: GPL-3.0-or-later.

CBUILD_CC Look in source line 17

This will hold compiler command for compiler that was used to compiler CBuild.

CC Look in source line 27

CBuild can provide bare define CC. Because it is not prefixed it can be disabled. This defined will be an alias to CBUILD_CC. If CBUILD_NO_CC is defined, CBuild will not provide CC define.

CBUILD_CARGS_WARN

#define CBUILD_CARGS_WARN

Default warning options. Enables almost all warnings except -Wcomments and -Woverride-init.

CBUILD_CARGS_WERROR

#define CBUILD_CARGS_WERROR

Promote all warnings to errors.

CBUILD_CARGS_PROFILE

#define CBUILD_CARGS_PROFILE

Setup profiles,

CBUILD_CARGS_DEBUG

#define CBUILD_CARGS_DEBUG

Add debug symbols,

CBUILD_CARGS_DEBUG_GDB

#define CBUILD_CARGS_DEBUG_GDB

Add debug symbols targeting gdb.

CBUILD_CARGS_MT

#define CBUILD_CARGS_MT

Enable multithreading (eg. add -pthread for POSIX).

CBUILD_CARGS_DEFINE

#define CBUILD_CARGS_DEFINE(defname)

Add a define based on compile-time literal.

CBUILD_CARGS_DEFINE_TEMP

#define CBUILD_CARGS_DEFINE_TEMP(defname)

Add a define based on runtime string. Uses cbuild_temp_malloc.

CBUILD_CARGS_DEFINE_VAL

#define CBUILD_CARGS_DEFINE_VAL(defname, val)

Add a define with a value. Both based on compile-time literal.

CBUILD_CARGS_DEFINE_VAL_TEMP

#define CBUILD_CARGS_DEFINE_VAL_TEMP(defname, val)

Add a define with a value. Both based on runtime string. Uses cbuild_temp_malloc.

CBUILD_CARGS_UNDEF

#define CBUILD_CARGS_UNDEF(defname)

Remove define based on compile-time literal.

CBUILD_CARGS_INCLUDE

#define CBUILD_CARGS_INCLUDE(file)

Add include based on compile-time literal.

CBUILD_CARGS_LIBINCLUDE

#define CBUILD_CARGS_LIBINCLUDE(lib)

Add library include (-l) based on compile-time literal.

CBUILD_CARGS_LIBDIR

#define CBUILD_CARGS_LIBDIR(src, obj)

Add library directories (-I and -L) based on compile-time literal.

CBUILD_CARGS_STD

#define CBUILD_CARGS_STD(std)

Set standard based on compile-time literal.

cbuild_selfrebuild

#define cbuild_selfrebuild(argc, argv)

Simple wrapper for self-rebuild. Only argv[0] is used. Other elements are used only to re-exec new binary with same arguments.

cbuild_selfrebuild_ex

#define cbuild_selfrebuild_ex(argc, argv, ...)

Complex wrapper for self-rebuild. Only argv[0] is used. This function allow to specify additional files to be checked when decision is made to rebuild binary or not.

__cbuild_selfrebuild

CBUILDDEF void __cbuild_selfrebuild(int argc, char** argv,
const char* argv0_path, cbuild_cmd_t files);

Perms self-rebuild.

  • int argc ARGC of program.
  • char** argv ARGV of program.
  • const char* argv0_path Path to file specified by argv[0].
  • cbuild_cmd_t files Primary file as first element and additional dependency files as other.

When this will result in a new binary

If any of the files from filescbuild_cmd_t are newer than argv[0]. If any of files in this array does not exist program will exit with error.

How rebuild is performed

CBUILD_CC is used as compiler. CBUILD_CARGS_WARN is used as default set of arguments. cbuild_selfrebuild_hook is called to resolve dynamic or user-provided arguments.

cbuild_selfrebuild_hook_t

typedef void (*cbuild_selfrebuild_hook_t)(cbuild_cmd_t* cmd);

This function receives command before files are appended and can modify it.

cbuild_selfrebuild_hook

extern cbuild_selfrebuild_hook cbuild_selfrebuild_hook_t;

This function is called by default __cbuild_selfrebuild

cbuild_compare_mtime

CBUILDDEF int cbuild_compare_mtime(const char* output, const char* input);

Compare mtime of 2 files. Same check as done by make.

  • =0 - Output is newer than input.
  • <0 - Error.
  • >0 - Output is older than input.

cbuild_compare_mtime_many

CBUILDDEF int cbuild_compare_mtime_many(const char* output, const char** inputs,
size_t num_inputs);

Compare mtime of 1 output file and multiple input files. Same check as done by make.

  • =0 - Output is newer than input.
  • <0 - Error.
  • >0 - Output is older than input. Number of files that are newer.