Skip to content

Tokens

Jump to bottom
starkos edited this page Apr 10, 2021 · 16 revisions

⚠️ We have a new website! Visit now for the most update to date documentation.
       This wiki is no longer being maintained.

Tokens provide the ability to substitute computed values into a configuration setting. Using tokens, you can specify a single value that automatically adjusts itself to different platforms and configurations.

Tokens come in two varieties: value tokens, and command tokens.

Value Tokens

Value tokens are expressions wrapped in a %{} sequence. Tokens have access to one or more context objects, depending on their scope within the project: wks, prj, cfg, and file. You can access all of the fields of these context objects within the token.

%{wks.name}
%{prj.location}
%{cfg.targetdir}

The contents of the %{} are run through loadstring() and executed at token-replacement time, so more complex replacements can be used. You can access any global value.

%{wks.name:gsub(' ', '_')}

You can use wks, prj, cfg, and file to represent the current workspace, project, configuration, and file configuration respectively. Note that these values must be in scope for the type of value you are trying to substitute or the object will be nil. You'll have to hunt around for the available fields until I have a chance to document them, but in general they follow the API names (includedirs, location, flags, etc.).

Some known tokens (feel free to add more as you use them):

wks.name
wks.location -- (location where the workspace/solution is written, not the premake-wks.lua file)

prj.name
prj.location -- (location where the project is written, not the premake-prj.lua file)
prj.language
prj.group

cfg.longname
cfg.shortname
cfg.kind
cfg.architecture
cfg.platform
cfg.system
cfg.buildcfg
cfg.buildtarget -- (see [target], below)
cfg.linktarget -- (see [target], below)
cfg.objdir

file.path
file.abspath
file.relpath
file.directory
file.reldirectory
file.name
file.basename -- (file part without extension)
file.extension -- (including '.'; eg ".cpp")

-- These values are available on build and link targets
-- Replace [target] with one of "cfg.buildtarget" or "cfg.linktarget"
--   Eg: %{cfg.buildtarget.abspath}
[target].abspath
[target].relpath
[target].directory
[target].name
[target].basename -- (file part without extension)
[target].extension -- (including '.'; eg ".cpp")
[target].bundlename
[target].bundlepath
[target].prefix
[target].suffix

Command Tokens

Command tokens represent a system level command in a platform-neutral way.

postbuildcommands {
	"{COPY} file1.txt file2.txt"
}

You can use command tokens anywhere you specify a command line, including:

Command tokens are replaced with an appropriate command for the target platform. For Windows, path separators in the commmand arguments are converted to backslashes.

The available tokens, and their replacements:

Token DOS Posix
{CHDIR} chdir {args} cd {args}
{COPYFILE} copy /B /Y {args} cp -f {args}
{COPYDIR} xcopy /Q /E /Y /I {args} cp -rf {args}
{DELETE} del {args} rm -rf {args}
{ECHO} echo {args} echo {args}
{MKDIR} mkdir {args} mkdir -p {args}
{MOVE} move /Y {args} mv -f {args}
{RMDIR} rmdir /S /Q {args} rm -rf {args}
{TOUCH} type nul >> {arg} && copy /b {arg}+,, {arg} touch {args}

Note that this token exists but is deprecated in favor of {COPYDIR} and {COPYFILE} | {COPY} | xcopy /Q /E /Y /I {args} | cp -rf {args} |

Tokens and Filters

Tokens are not expanded in filters. See issue 1306 for some illustrative examples.

Clone this wiki locally