xmake-docs/docs/api/scripts/extension-modules/core/language/language.md

core.language.language

Used to obtain information about the compiled language, generally used for the operation of code files.

language.extensions

• Get a list of code suffixes for all languages

Function Prototype

::: tip API

language.extensions()

:::

Parameter Description

No parameters required for this function.

Return Value

Type	Description
table	Returns a table with file extensions as keys and language source types as values

Usage

Get a list of code suffixes for all languages.

The results are as follows:

{
    [".c"] = cc,
    [".cc"] = cxx,
    [".cpp"] = cxx,
    [".m"] = mm,
    [".mm"] = mxx,
    [".swift"] = sc,
    [".go"] = gc
}

language.targetkinds

• Get a list of target types in all languages

Function Prototype

::: tip API

language.targetkinds()

:::

Parameter Description

No parameters required for this function.

Return Value

Type	Description
table	Returns a table with target types as keys and lists of supported linkers as values

Usage

Get a list of target types in all languages.

The results are as follows:

{
    binary = {"ld", "gcld", "dcld"},
    static = {"ar", "gcar", "dcar"},
    shared = {"sh", "dcsh"}
}

language.sourcekinds

• Get a list of source file types in all languages

Function Prototype

::: tip API

language.sourcekinds()

:::

Parameter Description

No parameters required for this function.

Return Value

Type	Description
table	Returns a table with source file types as keys and file extensions or extension lists as values

Usage

Get a list of source file types in all languages.

The results are as follows:

{
    cc = ".c",
    cxx = {".cc", ".cpp", ".cxx"},
    mm = ".m",
    mxx = ".mm",
    sc = ".swift",
    gc = ".go",
    rc = ".rs",
    dc = ".d",
    as = {".s", ".S", ".asm"}
}

language.sourceflags

• Load a list of source file compilation option names for all languages

Function Prototype

::: tip API

language.sourceflags()

:::

Parameter Description

No parameters required for this function.

Return Value

Type	Description
table	Returns a table with source file types as keys and compilation option name lists as values

Usage

Load a list of source file compilation option names for all languages.

The results are as follows:

{
    cc = {"cflags", "cxflags"},
    cxx = {"cxxflags", "cxflags"},
    ...
}

language.load

• Load the specified language

Function Prototype

::: tip API

language.load(name: <string>)

:::

Parameter Description

Parameter	Description
name	Required. Language name, e.g., "c++", "c"

Return Value

Type	Description
language	Returns a language object, or nil if it doesn't exist

Usage

Load a specific language object from the language name, for example:

local lang = language.load("c++")
if lang then
    print(lang:name())
end

language.load_sk

• Load the specified language from the source file type

Function Prototype

::: tip API

language.load_sk(sourcekind: <string>)

:::

Parameter Description

Parameter	Description
sourcekind	Required. Source file type, e.g., "cc", "cxx", "mm"

Return Value

Type	Description
language	Returns a language object, or nil if it doesn't exist

Usage

Load specific language objects from the source file type: cc, cxx, mm, mxx, sc, gc, as .., for example:

local lang = language.load_sk("cxx")
if lang then
    print(lang:name())
end

language.load_ex

• Load the specified language from the source file suffix name

Function Prototype

::: tip API

language.load_ex(extension: <string>)

:::

Parameter Description

Parameter	Description
extension	Required. Source file extension, e.g., ".cpp", ".c"

Return Value

Type	Description
language	Returns a language object, or nil if it doesn't exist

Usage

Load specific language objects from the source file extension: .cc, .c, .cpp, .mm, .swift, .go .., for example:

local lang = language.load_ex(".cpp")
if lang then
    print(lang:name())
end

language.sourcekind_of

• Get the source file type of the specified source file

Function Prototype

::: tip API

language.sourcekind_of(filepath: <string>)

:::

Parameter Description

Parameter	Description
filepath	Required. Source file path

Return Value

Type	Description
string	Returns the source file type, e.g., "cxx", "cc"

Usage

That is, from a given source file path, get the type of source file it belongs to, for example:

print(language.sourcekind_of("/xxxx/test.cpp"))

The result is: cxx, which is the c++ type. For the corresponding list, see: language.sourcekinds