This is a mirror page, please see the original page:
https://xmake.io/#/guide/project_examplesWe briefly introduce some commonly used project examples. More and more complete examples projects can be viewed in project examples.
We can also use the xmake create command to create various commonly used empty projects to quickly start. For the introduction of this command and the supported project templates, you can type the following command to view:
xmake create --help
Executable Program
target("test")
set_kind("binary")
add_files("src/*.c")
For a complete example, execute the following command to create:
xmake create -l c -t console test
Static Library Program
target("library")
set_kind("static")
add_files("src/library/*.c")
target("test")
set_kind("binary")
add_files("src/*.c")
add_deps("library")
We use add_deps to link a static library to test target.
For a complete example, execute the following command to create:
xmake create -l c -t static test
Share Library Program
target("library")
set_kind("shared")
add_files("src/library/*.c")
target("test")
set_kind("binary")
add_files("src/*.c")
add_deps("library")
We use add_deps to link a share library to test target.
For a complete example, execute the following command to create:
xmake create -l c -t shared test
Qt Program
Create an empty project:
v2.2.9 or higher:
$ xmake create -t qt.console test
$ xmake create -t qt.static test
$ xmake create -t qt.shared test
$ xmake create -t qt.quickapp test
$ xmake create -t qt.widgetapp test
For more project templates see: xmake create --help
Older version of v2.2.8:
$ xmake create -l c++ -t console_qt test
$ xmake create -l c++ -t static_qt test
$ xmake create -l c++ -t shared_qt test
$ xmake create -l c++ -t quickapp_qt test
xmake will detect Qt SDK automatically and we can also set the SDK directory manually.
$ xmake f --qt=~/Qt/Qt5.9.1
The MingW SDK specified above uses the environment that comes with the Tools directory under Qt. Of course, if there are other third-party MingW compilation environments, they can also be specified manually.
For details, please refer to: MingW Configuration.
For more details, please refer to: #160
In addition, currently xmake also supports Qt/Wasm. For details, see: Wasm Configuration
$ xmake f -p wasm
Static Library
target("qt_static_library")
add_rules("qt.static")
add_files("src/*.cpp")
add_frameworks("QtNetwork", "QtGui")
Shared Library
target("qt_shared_library")
add_rules("qt.shared")
add_files("src/*.cpp")
add_frameworks("QtNetwork", "QtGui")
Console Program
target("qt_console")
add_rules("qt.console")
add_files("src/*.cpp")
Quick Application
v2.2.9 or higher:
target("qt_quickapp")
add_rules("qt.quickapp")
add_files("src/*.cpp")
add_files("src/qml.qrc")
!> If you are using your own compiled static version of the QT SDK, you need to switch to the add_rules("qt.quickapp_static") static rule,
because the linked libraries are different and need to be statically linked.
Next, we try to compile, usually, if you use the Qt installation package to install by default, and do not modify the installation path, then in most cases you can automatically detect the root path of the QT SDK, for example:
$ xmake
checking for the architecture ... x86_64
checking for the Xcode directory ... /Applications/Xcode.app
checking for the SDK version of Xcode ... 10.15
checking for the Qt SDK directory ... /Users/ruki/Qt5.13.2/5.13.2/clang_64
checking for the Qt SDK version ... 5.13.2
[0%]: ccache compiling.release src/main.cpp
[49%]: compiling.qt.qrc src/qml.qrc
[100%]: linking.release test
Build ok!
Then we continue to run it:
$ xmake run
The effect is as follows:
Widgets Application
v2.2.9 or higher:
target("qt_widgetapp")
add_rules("qt.widgetapp")
add_headerfiles("src/*.h")
add_files("src/*.cpp")
add_files("src/mainwindow.ui")
-- add files with Q_OBJECT meta (only for qt.moc)
add_files("src/mainwindow.h")
!> The new version provides the qt.widgetapp rule, built-in QtWidgets built-in rules, the use of simpler, the following version of the qt.application is still supported, backward compatible:
target("qt_widgetapp")
add_rules("qt.application")
add_files("src/*.cpp")
add_files("src/mainwindow.ui")
add_files("src/mainwindow.h") -- add files with Q_OBJECT meta (only for qt.moc)
add_frameworks("QtWidgets")
!> If you are using your own compiled static version of the QT SDK, you need to switch to the add_rules("qt.widgetapp_static") static rule,
because the linked libraries are different and need to be statically linked.
The effect is as follows:
Android Application
After the 2.2.6 version, you can directly switch to the android platform to compile the Quick/Widgets application, generate the apk package, and install it to the device via the xmake install command.
$ xmake create -t quickapp_qt -l c ++ appdemo
$ cd appdemo
$ xmake f -p android --ndk=~/Downloads/android-ndk-r19c/ --android_sdk=~/Library/Android/sdk/ -c
$ xmake
[0%]: compiling.qt.qrc src/qml.qrc
[ 50%]: ccache compiling.release src/main.cpp
[100%]: linking.release libappdemo.so
[100%]: generating.qt.app appdemo.apk
Then install to the device:
$ xmake install
installing appdemo ...
installing build/android/release/appdemo.apk ..
success
install ok!👌
WDK Driver Program
xmake will detect WDK automatically and we can also set the WDK directory manually.
$ xmake f --wdk="G:\Program Files\Windows Kits\10" -c
$ xmake
If you want to known more information, you can see #159.
And see WDK examples
UMDF Driver Program
target("echo")
add_rules("wdk.driver", "wdk.env.umdf")
add_files("driver/*.c")
add_files("driver/*.inx")
add_includedirs("exe")
target("app")
add_rules("wdk.binary", "wdk.env.umdf")
add_files("exe/*.cpp")
KMDF Driver Program
target("nonpnp")
add_rules("wdk.driver", "wdk.env.kmdf")
add_values("wdk.tracewpp.flags", "-func:TraceEvents(LEVEL,FLAGS,MSG,...)", "-func:Hexdump((LEVEL,FLAGS,MSG,...))")
add_files("driver/*.c", {rule = "wdk.tracewpp"})
add_files("driver/*.rc")
target("app")
add_rules("wdk.binary", "wdk.env.kmdf")
add_files("exe/*.c")
add_files("exe/*.inf")
WDM Driver Program
target("kcs")
add_rules("wdk.driver", "wdk.env.wdm")
add_values("wdk.man.flags", "-prefix Kcs")
add_values("wdk.man.resource", "kcsCounters.rc")
add_values("wdk.man.header", "kcsCounters.h")
add_values("wdk.man.counter_header", "kcsCounters_counters.h")
add_files("*.c", "*.rc", "*.man")
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
add_values("wdk.tracewpp.flags", "-func:TracePrint((LEVEL,FLAGS,MSG,...))")
add_files("*.c", {rule = "wdk.tracewpp"})
add_files("*.rc", "*.inf")
add_files("*.mof|msdsm.mof")
add_files("msdsm.mof", {values = {wdk_mof_header = "msdsmwmi.h"}})
Package Driver
We can run the following command to generate a .cab driver package.
$ xmake [p|package]
$ xmake [p|package] -o outputdir
The output files like:
- drivers
- sampledsm
- debug/x86/sampledsm.cab
- release/x64/sampledsm.cab
- debug/x86/sampledsm.cab
- release/x64/sampledsm.cab
Driver Signing
The driver signing is disabled when we compile driver in default case,
but we can add set_values("wdk.sign.mode") to enable test/release sign.
TestSign
We can use test certificate of xmake to do testsign, but please run $xmake l utils.wdk.testcert install as admin to install a test certificate first (only once)!
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
Or we set a valid certificate thumbprint to do it in local machine.
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.thumbprint", "032122545DCAA6167B1ADBE5F7FDF07AE2234AAA")
We can also do testsign via setting store/company info.
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.store", "PrivateCertStore")
set_values("wdk.sign.company", "tboox.org(test)")
ReleaseSign
We can set a certificate file for release signing.
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "release")
set_values("wdk.sign.company", "xxxx")
set_values("wdk.sign.certfile", path.join(os.projectdir(), "xxxx.cer"))
Support Low-version System
We can set wdk.env.winver to generate a driver package that is compatible with a low version system.
set_values("wdk.env.winver", "win10")
set_values("wdk.env.winver", "win10_rs3")
set_values("wdk.env.winver", "win81")
set_values("wdk.env.winver", "win8")
set_values("wdk.env.winver", "win7")
set_values("wdk.env.winver", "win7_sp1")
set_values("wdk.env.winver", "win7_sp2")
set_values("wdk.env.winver", "win7_sp3")
We can also set windows version for WDK driver program:
$ xmake f --wdk_winver=[win10_rs3|win8|win7|win7_sp1]
$ xmake
WinSDK Application Program
target("usbview")
add_rules("win.sdk.application")
add_files("*.c", "*.rc")
add_files("xmlhelper.cpp", {rule = "win.sdk.dotnet"})
If you want to known more information, you can see #173.
MFC Application Program
MFC Static Library
target("test")
add_rules("win.sdk.mfc.static")
add_files("src/*.c")
MFC Shared Library
target("test")
add_rules("win.sdk.mfc.shared")
add_files("src/*.c")
MFC Application (Static)
target("test")
add_rules("win.sdk.mfc.static_app")
add_files("src/*.c")
MFC Application (Shared)
target("test")
add_rules("win.sdk.mfc.shared_app")
add_files("src/*.c")
iOS/MacOS Program
Application
Generate .app/.ipa application and supports iOS/MacOS.
target("test")
add_rules("xcode.application")
add_files("src/*.m", "src/**.storyboard", "src/*.xcassets")
add_files("src/Info.plist")
Create Project
We can also quickly create project through template:
$ xmake create -t xcode.macapp -l objc test
$ xmake create -t xcode.iosapp -l objc test
Build Program
$ xmake f -p [iphoneos|macosx]
$ xmake
[ 18%]: compiling.xcode.release src/Assets.xcassets
[ 27%]: processing.xcode.release src/Info.plist
[ 72%]: compiling.xcode.release src/Base.lproj/Main.storyboard
[ 81%]: compiling.xcode.release src/Base.lproj/LaunchScreen.storyboard
[ 45%]: ccache compiling.release src/ViewController.m
[ 63%]: ccache compiling.release src/AppDelegate.m
[ 54%]: ccache compiling.release src/SceneDelegate.m
[ 36%]: ccache compiling.release src/main.m
[ 90%]: linking.release test
[100%]: generating.xcode.release test.app
[100%]: build ok!
Codesign
For iOS programs, it will detect that the system first signs the app with available signatures. Of course, we can also manually specify other signature certificates:
$ xmake f -p iphoneos --xcode_codesign_identity='Apple Development: xxx@gmail.com (T3NA4MRVPU)' --xcode_mobile_provision='iOS Team Provisioning Profile: org.tboox.test --xcode_bundle_identifier=org.tboox.test'
$ xmake
If it is cumbersome to configure the signature every time, you can set it to the xmake global global configuration, or you can set it separately for each target in xmake.lua:
target("test")
add_rules("xcode.application")
add_files("src/*.m", "src/**.storyboard", "src/*.xcassets")
add_files("src/Info.plist")
add_values("xcode.bundle_identifier", "org.tboox.test")
add_values("xcode.codesign_identity", "Apple Development: xxx@gmail.com (T3NA4MRVPU)")
add_values("xcode.mobile_provision", "iOS Team Provisioning Profile: org.tboox.test")
How do we know the signature configuration we need? One is to view it in xcode. In addition, xmake also provides some auxiliary tools to dump all currently available signature configurations:
$ xmake l private.tools.codesign.dump
==================================== codesign identities ====================================
{
"Apple Development: waruqi@gmail.com (T3NA4MRVPU)" = "AF73C231A0C35335B72761BD3759694739D34EB1"
}
===================================== mobile provisions =====================================
{
"iOS Team Provisioning Profile: org.tboox.test" = "
AppIDName
XC org tboox test
ApplicationIdentifierPrefix
43AAQM58X3
...
We also provide other auxiliary tools to re-sign existing ipa / app programs, for example:
$ xmake l utils.ipa.resign test.ipa | test.app [codesign_identity] [mobile_provision] [bundle_identifier]
Among them, the following signature parameters are optional, if not set, then a valid signature will be detected by default:
$ xmake l utils.ipa.resign test.ipa
$ xmake l utils.ipa.resign test.app "Apple Development: waruqi@gmail.com (T3NA4MRVPU)"
$ xmake l utils.ipa.resign test.ipa "Apple Development: waruqi@gmail.com (T3NA4MRVPU)" iOS Team Provisioning Profile: org.tboox.test" org.tboox.test
Run the application
Currently only supports running macos program:
`console
$ xmake run `
The effect is as follows:
Package program
If it is an iOS program, it will generate an ipa installation package, if it is macOS, it will generate a dmg package (dmg package generation is still under development for the time being).
$ xmake package
output: build/iphoneos/release/arm64/test.ipa
package ok!
We also provide auxiliary tools to package the specified app program:
$ xmake l utils.ipa.package test.app output.ipa [iconfile.png]
Install
If it is an iOS program, it will install ipa to the device, if it is macos, it will install the app to the /Applications directory.
$ xmake install
We also provide auxiliary tools to install the specified ipa/app program to the device:
$ xmake l utils.ipa.install test.app
$ xmake l utils.ipa.install test.ipa
Uninstall
!> Currently only the macos program is supported
$ xmake uninstall
Framework Program
target("test")
add_rules("xcode.framework")
add_files("src/*.m")
add_files("src/Info.plist")
We can also quickly create project through template:
$ xmake create -t xcode.framework -l objc test
In addition, xmake v2.3.9 and above, xmake also provides a complete iosapp/macapp empty project template with framework library usage, you can fully experience framework compilation, dependent use and integration into app applications.
At the same time, if we turn on the emulator, xmake can support directly xmake install and xmake run to install the app to the emulator and load and run it.
$ xmake create -t xcode.iosapp_with_framework -l objc testapp
$ cd testapp
$ xmake f -p iphoneos -a x86_64
$ xmake
$ xmake install
$ xmake run
Bundle Program
target("test")
add_rules("xcode.bundle")
add_files("src/*.m")
add_files("src/Info.plist")
We can also quickly create project through template:
$ xmake create -t xcode.bundle -l objc test
Protobuf program
Using c library
add_requires("protobuf-c")
target("console_c")
set_kind("binary")
add_packages("protobuf-c")
add_files("src/*.c")
add_files("src/*.proto", {rules = "protobuf.c"})
In version 2.5.5, we can also set proto_public = true to export the proto header file search directory and open it to other parent targets for inheritance.
add_files("src/**.proto", {rules = "protobuf.c", proto_public = true})
Using the C++ library
add_requires("protobuf-cpp")
target("console_c++")
set_kind("binary")
set_languages("c++11")
add_packages("protobuf-cpp")
add_files("src/*.cpp")
add_files("src/*.proto", {rules = "protobuf.cpp"})
Cuda Program
Create an empty project:
$ xmake create -P test -l cuda
$ cd test
$ xmake
-- define target
target("cuda_console")
set_kind("binary")
add_files("src/*.cu")
-- generate SASS code for SM architecture of current host
add_cugencodes("native")
-- generate PTX code for the virtual architecture to guarantee compatibility
add_cugencodes("compute_30")
!> Starting with v2.2.7, the default build will enable device-link. (see Separate Compilation and Linking of CUDA C++ Device Code)
If you want to disable device-link, you can set it with add_values("cuda.devlink", false).
xmake will detect Cuda SDK automatically and we can also set the SDK directory manually.
$ xmake f --cuda=/usr/local/cuda-9.1/
$ xmake
If you want to known more information, you can see #158.
Lex & Yacc Program
target("calc")
set_kind("binary")
add_rules("lex", "yacc")
add_files("src/*.l", "src/*.y")
OpenMP Program
add_requires("libomp", {optional = true})
target("loop")
set_kind("binary")
add_files("src/*.cpp")
add_rules("c++.openmp")
add_packages("libomp")
If it is c code, you need to enable ʻadd_rules("c.openmp")`. If it is c/c++ mixed compilation, then these two rules must be set.
Fortran Program
After v2.3.6, the gfortran compiler is supported to compile fortran projects. We can quickly create an empty project based on fortran by using the following command:
After v2.3.8, xmake also supports Intel Fortran Compiler, you only need to switch the toolchain: xmake f --toolchain=ifort
$ xmake create -l fortran -t console test
Its xmake.lua content is as follows:
add_rules("mode.debug", "mode.release")
target("test")
set_kind("binary")
add_files("src/*.f90")
More code examples can be viewed here: Fortran Examples
Go Program
xmake also supports the construction of go programs, and also provides command support for creating empty projects:
$ xmake create -l go -t console test
The content of xmake.lua is as follows:
add_rules("mode.debug", "mode.release")
target("test")
set_kind("binary")
add_files("src/*.go")
In v2.3.6 version, xmake has made some improvements to its build support, and also supports cross compilation of go. For example, we can compile windows programs on macOS and linux:
$ xmake f -p windows -a x86
In addition, the new version also initially supports the third-party dependency package management of go:
add_rules("mode.debug", "mode.release")
add_requires("go::github.com/sirupsen/logrus", {alias = "logrus"})
add_requires("go::golang.org/x/sys/internal/unsafeheader", {alias = "unsafeheader"})
if is_plat("windows") then
add_requires("go::golang.org/x/sys/windows", {alias = "syshost"})
else
add_requires("go::golang.org/x/sys/unix", {alias = "syshost"})
end
target("test")
set_kind("binary")
add_files("src/*.go")
add_packages("logrus", "syshost", "unsafeheader")
However, there are still some imperfections. For example, all cascading dependency packages must be manually configured at present, which will be a bit more cumbersome and needs to be improved in the future.
For more examples, see: Go Examples
Dlang Program
Create an empty project:
$ xmake create -l dlang -t console test
xmake.lua content:
add_rules("mode.debug", "mode.release")
target("test")
set_kind("binary")
add_files("src/*.d")
Starting from the v2.3.6 version, xmake adds support for dub package management, which can quickly integrate third-party dependency packages of dlang:
add_rules("mode.debug", "mode.release")
add_requires("dub::log 0.4.3", {alias = "log"})
add_requires("dub::dateparser", {alias = "dateparser"})
add_requires("dub::emsi_containers", {alias = "emsi_containers"})
add_requires("dub::stdx-allocator", {alias = "stdx-allocator"})
add_requires("dub::mir-core", {alias = "mir-core"})
target("test")
set_kind("binary")
add_files("src/*.d")
add_packages("log", "dateparser", "emsi_containers", "stdx-allocator", "mir-core")
However, there are still some imperfections. For example, all cascading dependency packages must be manually configured at present, which will be a bit more cumbersome and needs to be improved in the future.
For more examples, see: Dlang Examples
Rust Program
Create an empty project:
$ xmake create -l rust -t console test
xmake.lua content:
add_rules("mode.debug", "mode.release")
target("test")
set_kind("binary")
add_files("src/*.rs")
For more examples, see: Rust Examples
Swift Program
Create an empty project:
$ xmake create -l swift -t console test
xmake.lua content:
add_rules("mode.debug", "mode.release")
target("test")
set_kind("binary")
add_files("src/*.swift")
For more examples, see: Swift Examples
Objc Program
Create an empty project:
$ xmake create -l objc -t console test
xmake.lua content:
add_rules("mode.debug", "mode.release")
target("test")
set_kind("binary")
add_files("src/*.m")
For more examples, see: Objc Examples
Zig Program
Create an empty project:
$ xmake create -l zig -t console test
xmake.lua content:
add_rules("mode.debug", "mode.release")
target("test")
set_kind("binary")
add_files("src/*.zig")
For more examples, see: Zig Examples
Linux Bpf program
Since 2.5.3, it supports bpf program construction, supports both linux and android platforms, and can automatically pull llvm and android ndk toolchains.
For more details, please see: #1274
add_rules("mode.release", "mode.debug")
add_rules("platform.linux.bpf")
add_requires("linux-tools", {configs = {bpftool = true}})
add_requires("libbpf")
if is_plat("android") then
add_requires("ndk >=22.x")
set_toolchains("@ndk", {sdkver = "23"})
else
add_requires("llvm >=10.x")
set_toolchains("@llvm")
add_requires("linux-headers")
end
target("minimal")
set_kind("binary")
add_files("src/*.c")
add_packages("linux-tools", "linux-headers", "libbpf")
set_license("GPL-2.0")