Macro Functions

Supported platforms:
Available since: Gideros 2017.10

Description

Macro Functions receive a list of tokens and output a string which will be pasted into code at compile time. <syntaxhighlight lang="lua"> name @ (| ...body... |) </source>

You should use parenthesis around markers - '|' is the preferred marker.

The same marker should be used to close macro body with closing parenthesis right after it.

You can use any of these markers:

\`~ ! # $ % ^ & * / + = |

You can redefine a macro with @@: <syntaxhighlight lang="lua"> name @@ (| ...another_body... |) </source>

To call macro function use its name with parenthesis as with usual functions: <syntaxhighlight lang="lua"> name(...arguments...) </source>

Examples

Enumeration <syntaxhighlight lang="lua"> enum @ (| local t = ... local r = {} for i = 1, #t, 2 do table.insert(r, t[i] .. " @ " .. i // 2 + 1) end print(table.concat(r, " ")) return table.concat(r, " ") |)

enum(apple, orange, melon) print(apple, orange, melon) --> 1 2 3</source>

Turning off the print command <syntaxhighlight lang="lua"> print @ (| return "" |) </source>

Unroll loops <syntaxhighlight lang="lua"> dotimes @ (| local times = table.remove(..., 1) return (table.concat(..., " ").." "):rep(times) |)

local t = {}

dotimes(10 print "Boom!") </source>

A Sum macro example <syntaxhighlight lang="lua"> -- comma counts as an argument meaning MYSUM(o1, o2) has three parameters MYSUM @ (| return "("..(...)[1] + (...)[3] ..")" |) print (MYSUM(1,2) * MYSUM(3,1)) </source>

Methods

Events Constants

---

• Main Page
• Lua API
• Main API
• Plugins