Custom Description Scope API

We can use interp_add_scopeapis to register custom description scope APIs to support custom configuration domains and interfaces.

Basic Example

EXPLORER

src

main.cpp

xmake.lua

Lua xmake.lua

123456789101112131415161718192021222324252627282930313233

add_rules("mode.debug", "mode.release")

-- register scope apis
interp_add_scopeapis("myscope.set_name", "myscope.add_list", {kind = "values"})
interp_add_scopeapis("myscope.on_script", {kind = "script"})

-- use myscope
myscope("hello")
    set_name("foo")
    add_list("value1", "value2")
    on_script(function ()
        print("hello")
    end)

target("test")
    set_kind("binary")
    add_files("src/*.cpp")
    on_config(function (target)
        import("core.project.project")
        
        -- get scope data
        local myscope = project.scope("myscope")
        for name, scope in pairs(myscope) do
            print("myscope(%s)", name)
            print("    name: %s", scope:get("name"))
            print("    list: %s", table.concat(scope:get("list"), ", "))
            print("    script:")
            local script = scope:get("script")
            if script then
                script()
            end
        end
    end)

Build and Run

$ xmake
$ xmake run