Skip to content

custom_commands.md

Latest commit

 

History

History
68 lines (46 loc) · 3.17 KB

custom_commands.md

File metadata and controls

68 lines (46 loc) · 3.17 KB

Target commands for Compile and Link

When constructing custom commands we need to supply our own pattern to the buildsystem

This is done by overriding the 3 base::Target::Config strings

base::Target::Config config;

config.pch_command = "{compiler} {preprocessor_flags} {include_dirs} {common_compile_flags} {pch_compile_flags} {compile_flags} -o {output} -c {input}";

config.compile_command = "{compiler} {preprocessor_flags} {include_dirs} {common_compile_flags} {pch_object_flags} {compile_flags} -o {output} -c {input}";

config.link_command = "{cpp_compiler} {link_flags} {compiled_sources} -o {output} {lib_dirs} {lib_deps}";

General

The following {} commands are available to pch_command, compile_command and link_command

See build.cpp Target::Build API

  • include_dirs: Aggregated include directories for header files
  • lib_dirs: Aggregated lib directories for external libraries
  • preprocessor_flags: Preprocessor definitions
  • common_compile_flags: Common compile flags for PCH, ASM, C and CPP files
  • link_flags: Flags supplied during linking
  • asm_compiler: Assembly compiler
  • c_compiler: C compiler
  • cpp_compiler: C++ compiler
  • archiver: Archiver for Static Libraries
  • linker: Linker usually used during the Linking phase / Library creation

NOTE, When PCH is not used these options are aggregated to an empty string ("")

  • pch_compile_flags: PCH flags applied when compiling a PCH
  • pch_object_flags: PCH flags applied to object files after compiling a PCH
  • pch_object_output: [Specific use case] Certain compilers (MSVC) require source/object with the header inputs. input_source (mentioned below) is added locally during pch_command translation whereas pch_object_output is added globally. (However the pch_object_output will most likely be used by link_command translation if added by the user.)

PCH Specific

See CompilePch::ConstructCompileCommand API

  • compiler: Selects CPP compiler if project contains CPP source else C compiler
  • compile_flags: Selects CPP flags if project contains CPP source else C flags
  • output: PCH output path
  • input: PCH input generated path (Headers are aggregated into a .h file)
  • input_source: PCH input source generated path (Dummy source file with corresponding extension, .c for C source and .cpp for C++ source)

Compile Specific

See CompileObject::CacheCompileCommands API

  • compiler: Automatically chosen amongst ASM, C and C++ toolchain compiler
  • compile_flags: Automatically chosen amongst {c/cpp}_flags
  • output: Object file
  • input: Input source file

Links Specific

See LinkTarget::CacheLinkCommand API

  • output: Generated target as Target::GetName()
  • compiled_sources: Aggregated object files
  • lib_deps: External libraries and full path libraries