Introduction

IrisBuild is a meta build system for cross-platform projects. Currently it was used in project Kaleido3D. We can also use it to generate Visual Studio solutions for Windows, Android and iOS project with full featured code-complete functionality.

Supported Toolchains:

• Visual Studio 2017+
• Android NDK 14+
• iOS Build Environment on Windows
• Xcode 8+
• PlayStation
• Gradle

Features

• GN build syntax support (Google's Generate Ninja)
  • Built-in variables: target_os,target_arch,target_config
  • Built-in function for targets:
    • shared_library, static_library, executable (include apple app bundle, game console targets)
    • android_apk
      • maven package downloader
      • AndroidManifest merging
      • apk signing
      • jni compilation and packaging
    • ohos_hap, for HUAWEI's HarmonyOS
• Built-in functions:
  • zip & unzip
  • download & download_and_extract
• Supported source file types:
  • asm, c, cpp, objc, objcc, ispc, swift, pssl
  • java (android)
  • rust
• Visual Studio Code syntax highlighter

Lastest Update

• 2021/02/19 Updates:
  • Add AndroidApk initially build support
• 2021/01/09 Updates:
  • Add SwiftLang support
• 2020/11/24 Updates:
  • Add PS4/5 support
  • GN grammar compatible
  • Add GUI support

Built-in variables

• __file__ : str
• __root_dir__ : str
• __build_dir__ : str
• __is_build__ : bool
• __is_generate__: bool
• __ide__: str
• target_os : str
• target_arch : str
• target_config : str

target built-in vars

• force_static_crt : bool, build for windows
• force_clang : bool, build objc for windows
• force_universal : bool, build for macOS
• platform_white_list : string_list
• configs : string_list
• output_dir : str
• precompiled_header : str
• precompiled_source : str
• visibility : string_list
• sources : string_list
• defines : string_list
• deps : string_list
• include_dirs : string_list
• lib_dirs : string_list
• libs : string_list
• ldflags : string_list
• framework_dirs : string_list, depend framework search directories.
• frameworks : string_list, depend frameworks.
• cflags : string_list
• clangs_cc/objc/objcc/ispc/swift/rust : string_list

Target os built-in variables

• Windows
  • msvc.sys_incs : string_list
  • msvc.cflags : string_list
  • msvc.cflags_cc : string_list
  • msvc.has_clang : bool
  • msvc.clang.root : str
  • msvc.clang.path : str
  • msvc.clang.ldflags : string_list
  • msvc.clang.cflags : string_list
  • msvc.clang.cflags_asm : string_list
  • msvc.clang.cflags_cc : string_list
  • msvc.clang.cflags_objc : string_list
  • msvc.clang.cflags_objcc : string_list
• Playstation
  • Both: has_ps4_support : bool, has_ps5_support : bool.
  • ps4.clang.root : str
  • ps4.clang.path : str
  • ps4.clang.cflags : string_list
  • ps4.clang.cflags_asm : string_list
  • ps4.clang.cflags_cc : string_list
  • ps4.clang.cflags_objc : string_list
  • ps4.clang.cflags_objcc : string_list
  • ps5.clang.root : str
  • ps5.clang.path : str
  • ps5.clang.cflags : string_list
  • ps5.clang.cflags_asm : string_list
  • ps5.clang.cflags_cc : string_list
  • ps5.clang.cflags_objc : string_list
  • ps5.clang.cflags_objcc : string_list
  • ps5.clang.ldflags : string_list
• Android (WIP)
  • android.java_home : str
  • android.sdk.home : str
  • android.ndk.home : str
  • android.clang.root : str
  • android.clang.path : str
  • android.clang.cflags : string_list
  • android.clang.cflags_asm : string_list
  • android.clang.cflags_cc : string_list
  • android.clang.cflags_objc : string_list
  • android.clang.cflags_objcc : string_list
• iOS (WIP)
  • ios.build_on_windows : bool
  • ios.clang.sysroot : str
  • ios.clang.cflags : string_list
  • ios.clang.cflags_cc : string_list
  • ios.clang.cflags_objc : string_list
  • ios.clang.cflags_objcc : string_list
  • ios.clang.cflags_asm : string_list
• MacOS (WIP)
  • macos.build_on_windows : bool
  • macos.clang.sysroot : str
  • macos.clang.cflags : string_list
  • macos.clang.cflags_cc : string_list
  • macos.clang.cflags_objc : string_list
  • macos.clang.cflags_objcc : string_list
  • macos.clang.cflags_asm : string_list
• HarmonyOS (TODO)
• Linux (TODO)

Language built-in variables

• ISPC
  • has_ispc : bool
  • ispc.os : str
• Swift
• Rust
• Java

---

Example

shared_library("newLibrary") {
  force_static_crt = true
  force_clang = false
  platform_white_list = ["windows"]
  output_dir = "$__build_dir__"
  sources = ["main.cc"]
  include_dirs = ["."]
  clangs_cc = ["/O0", "/g"]
  libs = ["user32.lib"]
}

---

Scope Expression

variable scope

xen = {
    l = [5,3]
    p = "nig"
}
// xen.l : list
// xen.p : str

named scope

variable has serveral named scope

prog("xxx") {
    l = [5,3]
    p = "nig"
}
// prog.xxx.l : list
// prog.xxx.p : str

---

Function Call Expression

ret = execute("ls /") // without named arg
ret = execute(command = "ls /") // with named args

Lambda function

    download_and_extract(predownload_url, "../temp")
    execute("xbgn --build ../")
}
on_prebuild = () {
}
on_post_build = () {
    pack(target)
}

Target Creation Functions

• static_library(name) { scope }
• shared_library(name) { scope }
• framework(name) { scope }
  • resources : string_list
  • o_type : str, executable/bundle/dynamic library(default)/static library
• executable(name) { scope }
  • as_apple_app : bool, macOS/iOS app bundle, if target_os is ios, it is true.
  • pack_ios_ipa : bool, iOS specific
  • app_id : str, used for both android apk and apple app
  • apple_plist_info : str
  • apple_code_sign_id : str, code signing entity for apple app
  • as_android_apk : bool, for android app target (pure native), otherwise android elf generated.
  • as_ohos_hap : bool, for Huawei's OHOS app
• android_apk(name) { scope }
  • compileSdkVersion: int
  • defaultConfig: scope
    • applicationId: str
    • minSdkVersion: int
    • targetSdkVersion: int
    • versionCode: int
    • versionName: str
  • java: scope
    • srcDirs: list
    • jarLibs: list
  • resDir: str
  • manifest: str
  • jnis: list

Builtin Functions

• zip(file_list, root_dir, dest_file): compress file_list to single dest zip under root dir.
• unzip(src_path, dst_dir): extract zip file from source path to dest dir.
• execute(cmd) -> (code, stdout, stderr): execute command line
• download(url, file, proxy): download file to file path
• git_clone(url, dir)
• source_set
• config
• group

    download(url = "http://sss.xx/ff.zip", file = "xx.zip")
    unzip("xx.zip", dest_dir)

---

If And Match Expression

if(var) {
    echo("hello var")
}

match(target_os) {
    "windows" | "ios" => {
        echo("Wow~~~")
    },
    "ps5" => {
        echo("Wow...")
    }
}

---

Loop Expression (WIP)

for i = 0...8 {

}

for i in tests 
{
   // continue
}

// need parse dict
for i in [
    "ss", //string 
    "uu" : { 
        "8788" : true,
        "sds" : 88 
        } // dict
    ] // array
{

  break
}

The Details documented in the Wiki