build_tools

fibjs's build_tools based on .cmake

Getting Started

To use build_tools for fibjs, you need install:

• CMake >= 3.0
• C/Cpp Compiler
  • Windows: clang/VC++
  • Linux: clang
  • MacOS: clang

To explain how to use built_tools, we try to compile examples/hello.

All <built_tool_path> in codes refers to this project's root path.

Workflow

One CMake project per repository, configured and built in one pass:

cmake -DBUILD_ARCH=x64 -DBUILD_TYPE=release -DBT_BIN_DIR=$PWD/bin \
      -S . -B out/Linux_x64_release
cmake --build out/Linux_x64_release -- -j8

cmake/config.cmake detects the platform/architecture/type (overridable with -DBUILD_OS, -DBUILD_ARCH, -DBUILD_TYPE, -DBUILD_JOBS) and computes the artifact directory BT_BIN_DIR (bin/<OS>_<ARCH>_<TYPE>).

A top-level CMakeLists.txt adds the projects with add_subdirectory and calls bt_config_target() once for the whole tree (feature checks and the generated glibc_config.h / std_config.h / gitinfo.h).

The historical script-mode driver (cmake-scripts/get_env.cmake with the build() function, driven by a build.cmake at the repository root) was removed; builds are plain CMake projects now. A repository that used to carry one (the addon repositories) builds by dropping the file.

Create CMakeLists.txt

Add one CMakeLists.txt on your project. like examples/hello/CMakeLists.txt.

To build one static Library, include cmake/Library.cmake

cmake_minimum_required(VERSION 3.10)

include(<built_tool_path>/cmake/Library.cmake)

Or put one CMakeLists.txt on project_root's test directory, like examples/hello/test/CMakeLists.txt.

To build one test executation, include cmake/LibraryTest.cmake

cmake_minimum_required(VERSION 3.10)

include(<built_tool_path>/cmake/LibraryTest.cmake)

Run CMake

The example is a repository of its own: its entry script hands the arguments to scripts/build, which configures and builds the project in one pass.

cd examples/hello
bash build x64 release -j4

see more configuration on

• examples/hello/build for bash
• examples/hello/build.cmd for windows cmd

Assembly sources

CMake keeps one "extension -> language" map per configure, and it gives an extension to the language that was enabled last. A build tree that enables more than one assembly language (for example ASM_MASM and ASM_NASM, as the vendored tree does on Windows) would therefore assemble the sources of a library with the assembler of another one.

A library turns the language of its .asm sources on with cmake/option_asm.cmake's enable_asm_language(), which enables the language and states that the sources of that library are written in it:

include(<built_tool_path>/cmake/option_asm.cmake)

enable_asm_language(ASM_MASM)   # or ASM_NASM, ASM, ...

cmake/option_asm.cmake then pins the .asm sources of that library to the language with the LANGUAGE source property. A library that never enables an assembly language needs nothing, and a build tree with a single assembly language is assembled with the language of the extension as before.

The NASM assembler of the Windows targets ships with this repository (tools/asm/nasm.exe) and is set by cmake/config.cmake, so the libraries do not carry copies of it.

Copyright

MIT License