--
-- always include _preload so that the module works even when not embedded.
--
if premake.extensions == nil or premake.extensions.qt == nil then
include ( "_preload.lua" )
end
--
-- define the qt extension
--
premake.extensions.qt = {
--
-- these are private, do not touch
--
enabled = false,
defaultpath = os.getenv("QTDIR") or os.getenv("QT_DIR")
}
--
-- include list of modules
--
include ( "qtmodules.lua" )
--
-- Enable Qt for a project. Be carefull, although this is a method, it will enable Qt
-- functionalities only in the current configuration.
--
function premake.extensions.qt.enable()
local qt = premake.extensions.qt
-- enable Qt for the current config
qtenabled ( true )
-- setup our overrides if not already done
if qt.enabled == false then
qt.enabled = true
premake.override(premake.oven, "bakeFiles", qt.customBakeFiles)
premake.override(premake.oven, "bakeConfig", qt.customBakeConfig)
premake.override(premake.fileconfig, "addconfig", qt.customAddFileConfig)
end
end
--
-- Get the include, lib and bin paths
--
function premake.extensions.qt.getPaths(cfg)
-- get the main path
local qtpath = cfg.qtpath or premake.extensions.qt.defaultpath
-- return the paths
return cfg.qtincludepath or (qtpath and qtpath .. "/include"),
cfg.qtlibpath or (qtpath and qtpath .. "/lib"),
cfg.qtbinpath or (qtpath and qtpath .. "/bin")
end
--
-- Get the Qt version number
--
-- @param cfg
-- The input configuration
-- @param includepath
-- The Qt include path
-- @return
-- The Qt version string
--
function premake.extensions.qt.getVersion(cfg, includepath)
-- get the version number
local qtversion = cfg.qtversion
-- if we haven't cached the version and/or the project didn't specify one...
-- try and work it out
if qtversion == nil then
-- pre-5.6 stored the version string in qglobal.h ; post-5.6 in qconfig.h
local qtheaderpaths = { includepath .. "/QtCore/qconfig.h", includepath .. "/QtCore/qglobal.h" }
for _, headerpath in ipairs(qtheaderpaths) do
-- scan the file if it exists
local file = io.open(headerpath)
if file ~= nil then
-- scan to find 'QT_VERSION_STR' and extract the version number
for line in file:lines() do
if line:find("QT_VERSION_STR") then
qtversion = line:sub(line:find("\"")+1, line:find("\"[^\"]*$")-1)
break
end
end
io.close(file)
end
-- if we found the version, break out of the loop
if qtversion ~=nil then
break
end
end
end
return qtversion
end
--
-- A small function which will get the generated directory for a given config.
-- If objdir was specified, it will be used. Else, it's the project's location +
-- obj + configuration + platform
--
-- @param cfg
-- The input configuration
--
function premake.extensions.qt.getGeneratedDir(cfg)
-- check if the user specified a qtgenerateddir
if cfg.qtgenerateddir ~= nil then
return cfg.qtgenerateddir
end
-- try the objdir, if it's already baked
if cfg.objdir ~= nil then
return cfg.objdir
end
-- last resort, revert to the default obj path used by premake.
-- note : this is a bit hacky, but there is no easy "getobjdir(cfg)" method in
-- premake, thus this piece of code
dir = path.join(cfg.project.location, "obj")
if cfg.platform then
dir = path.join(dir, cfg.platform)
end
dir = path.join(dir, cfg.buildcfg)
return path.getabsolute(dir)
end
--
-- Override the premake.oven.bakeConfig method to configure the configuration object
-- with the Qt module (e.g. add the include directories, the links, etc.)
--
-- @param base
-- The original bakeConfig method.
-- @param wks
-- The current workspace.
-- @param prj
-- The current project.
-- @param buildcfg
-- The current configuration.
-- @param platform
-- The current platform.
-- @param extraFilters
-- Optional additional filters.
-- @return
-- The configuration object.
--
function premake.extensions.qt.customBakeConfig(base, wks, prj, buildcfg, platform, extraFilters)
local qt = premake.extensions.qt
local modules = qt.modules
-- bake
local config = base(wks, prj, buildcfg, platform, extraFilters)
-- do nothing if qt is not enabled for this config
if config.qtenabled ~= true then
return config
end
-- get the needed pathes
local qtinclude, qtlib, qtbin = qt.getPaths(config)
if qtinclude == nil or qtlib == nil or qtbin == nil then
error(
"Some Qt paths were not found. Ensure that you set the Qt path using\n" ..
"either 'qtpath' in your project configuration or using the QTDIR or\n" ..
"QT_DIR environment variable. You can also use the 'qtincludepath',\n" ..
"'qtlibpath' and 'qtbinpath' individually."
)
end
-- bake paths in the config (in case they were retrieved from the environment variable, they
-- will not be in the config objects, and we need them in the other baking methods)
config.qtincludepath = qtinclude
config.qtlibpath = qtlib
config.qtbinpath = qtbin
-- add the includes and libraries directories
table.insert(config.includedirs, qtinclude)
table.insert(config.libdirs, qtlib)
-- platform specifics
if _TARGET_OS == "macosx" then
-- -F set where the frameworks are located, and it's needed for header and libs
table.insert(config.buildoptions, "-F" .. qtlib)
table.insert(config.linkoptions, "-F" .. qtlib)
-- for dynamic libs resolution
table.insert(config.linkoptions, "-Wl,-rpath," .. qtlib)
elseif _TARGET_OS == "linux" then
-- for dynamic libs resolution
table.insert(config.linkoptions, "-Wl,-rpath," .. qtlib)
end
-- add the modules
for _, modulename in ipairs(config.qtmodules) do
-- private modules are indicated by modulename-private
-- this will implicitly add the associated public module and the private module header path
if modulename:endswith("-private") then
-- we need the version for the private header path
config.qtversion = qt.getVersion(config, qtinclude)
if config.qtversion == nil then
error(
"Cannot add module '" .. modulename .. "' - Unable to determine Qt Version.\n" ..
"You can explicitly set the version number using 'qtversion' in your project\n" ..
"configuration."
)
end
-- truncate the "-private"
modulename = modulename:sub(1, -9)
-- add the private part of the module
local module = modules[modulename]
if module ~= nil then
local privatepath = path.join(qt.getIncludeDir(config, module), config.qtversion)
table.insert(config.includedirs, privatepath)
table.insert(config.includedirs, path.join(privatepath , module.include))
end
end
-- add the public part of the module
if modules[modulename] ~= nil then
local module = modules[modulename]
local prefix = config.qtprefix or ""
local suffix = config.qtsuffix or ""
local libname = prefix .. module.name .. suffix
-- configure the module
table.insert(config.includedirs, qt.getIncludeDir(config, module))
if _TARGET_OS == "macosx" then
table.insert(config.links, path.join(qtlib, module.include .. ".framework"))
else
table.insert(config.links, libname)
end
if module.defines ~= nil then
qt.mergeDefines(config, module.defines)
end
-- add additional links
if module.links ~= nil then
for _, additionallink in ipairs(module.links) do
table.insert(config.links, additionallink)
end
end
end
end
-- return the modified config
return config
end
--
-- Override the premake.oven.bakeFiles method to be able to add the Qt generated
-- files to the project.
--
-- @param base
-- The original bakeFiles method.
-- @param prj
-- The current project.
-- @return
-- The table of files.
--
function premake.extensions.qt.customBakeFiles(base, prj)
local qt = premake.extensions.qt
local project = premake.project
-- parse the configurations for the project
for cfg in project.eachconfig(prj) do
-- ignore this config if Qt is not enabled
if cfg.qtenabled == true then
local mocs = {}
local qrc = {}
local ui = false
local objdir = qt.getGeneratedDir(cfg)
-- check each file in this configuration
table.foreachi(cfg.files, function(filename)
if qt.isUI(filename) then
ui = true
elseif qt.isQRC(filename) then
table.insert(qrc, filename)
elseif qt.needMOC(filename) then
table.insert(mocs, filename)
end
end)
-- include path for uic generated headers
if ui == true then
table.insert(cfg.includedirs, objdir)
end
-- the moc files
table.foreachi(mocs, function(filename)
table.insert(cfg.files, objdir .. "/moc_" .. path.getbasename(filename) .. ".cpp")
end)
-- the qrc files
table.foreachi(qrc, function(filename)
table.insert(cfg.files, objdir .. "/qrc_" .. path.getbasename(filename) .. ".cpp")
end)
end
end
return base(prj)
end
--
-- Override the base premake.fileconfig.addconfig method in order to add our
-- custom build rules for special Qt files.
--
-- @param base
-- The base method that we must call.
-- @param fcfg
-- The file configuration object.
-- @param cfg
-- The current configuration that we're adding to the file configuration.
--
function premake.extensions.qt.customAddFileConfig(base, fcfg, cfg)
-- call the base method to add the file config
base(fcfg, cfg)
-- do nothing else if Qt is not enabled
if cfg.qtenabled ~= true then
return
end
-- get the current config
local config = premake.fileconfig.getconfig(fcfg, cfg)
-- now filter the files, and depending on their type, add our
-- custom build rules
local qt = premake.extensions.qt
-- ui files
if qt.isUI(config.abspath) then
qt.addUICustomBuildRule(config, cfg)
-- resource files
elseif qt.isQRC(config.abspath) then
qt.addQRCCustomBuildRule(config, cfg)
-- moc files
elseif qt.needMOC(config.abspath) then
qt.addMOCCustomBuildRule(config, cfg)
end
-- the cpp files generated by the qrc tool can't use precompiled header, so
-- if we have pch and the file is a Qt generated one, check if it's generated
-- by qrc to disable pch for it.
if cfg.pchheader and config.abspath:find(qt.getGeneratedDir(cfg), 1, true) then
-- the generated dir path might contain special pattern character, so escape them
local pattern = path.wildcards(qt.getGeneratedDir(cfg))
-- if it's a qrc generated file, disable pch
if config.abspath:find(pattern .. "/qrc_.+%.cpp") then
config.flags.NoPCH = true
end
end
end
--
-- Checks if a file is a ui file.
--
-- @param filename
-- The file name to check.
-- @return
-- true if the file needs to be run through the uic tool, false if not.
--
function premake.extensions.qt.isUI(filename)
return path.hasextension(filename, { ".ui" })
end
--
-- Adds the custom build for ui files.
--
-- @param fcfg
-- The config for a single file.
-- @param cfg
-- The config of the project ?
--
function premake.extensions.qt.addUICustomBuildRule(fcfg, cfg)
local qt = premake.extensions.qt
-- get the output file
local output = qt.getGeneratedDir(cfg) .. "/ui_" .. fcfg.basename .. ".h"
-- build the command
local command = "\"" .. fcfg.config.qtbinpath .. "/uic\" -o \"" .. path.getrelative(fcfg.project.location, output) .. "\" \"" .. fcfg.relpath.. "\""
-- if we have custom commands, add them
if fcfg.config.qtrccargs then
table.foreachi(fcfg.config.qtuicargs, function (arg)
command = command .. " \"" .. arg .. "\""
end)
end
-- add the custom build rule
fcfg.buildmessage = "Uic'ing " .. fcfg.name
fcfg.buildcommands = { command }
fcfg.buildoutputs = { output }
end
--
-- Checks if a file is a qrc file.
--
-- @param filename
-- The file name to check.
-- @return
-- true if the file needs to be run through the rcc tool, false if not.
--
function premake.extensions.qt.isQRC(filename)
return path.hasextension(filename, { ".qrc" })
end
--
-- Adds the custom build for ui files.
--
-- @param fcfg
-- The config for a single file.
-- @param cfg
-- The config of the project ?
--
function premake.extensions.qt.addQRCCustomBuildRule(fcfg, cfg)
local qt = premake.extensions.qt
-- get the input and output files
local output = qt.getGeneratedDir(cfg) .. "/qrc_" .. fcfg.basename .. ".cpp"
-- build the command
local command = "\"" .. fcfg.config.qtbinpath .. "/rcc\" -name \"" .. fcfg.basename .. "\" -no-compress \"" .. fcfg.relpath .. "\" -o \"" .. path.getrelative(fcfg.project.location, output) .. "\""
-- if we have custom commands, add them
if fcfg.config.qtrccargs then
table.foreachi(fcfg.config.qtrccargs, function (arg)
command = command .. " \"" .. arg .. "\""
end)
end
-- get the files embedded on the qrc, to add them as input dependencies :
-- if we edit a .qml embedded in the qrc, we want the qrc to re-build whenever
-- we edit the qml file
local inputs = qt.getQRCDependencies(fcfg)
-- add the custom build rule
fcfg.buildmessage = "Rcc'ing " .. fcfg.name
fcfg.buildcommands = { command }
fcfg.buildoutputs = { output }
if #inputs > 0 then
fcfg.buildinputs = inputs
end
end
--
-- Get the files referenced by a qrc file.
--
-- @param fcfg
-- The configuration of the file
-- @return
-- The list of project relative file names of the dependencies
--
function premake.extensions.qt.getQRCDependencies(fcfg)
local dependencies = {}
local file = io.open(fcfg.abspath)
-- ensure the file was correctly opened
if file ~= nil then
local qrcdirectory = path.getdirectory(fcfg.abspath)
local projectdirectory = fcfg.project.location
-- parse the qrc file to find the files it will embed
for line in file:lines() do
-- try to find the entries
local match = string.match(line, "(.+)")
if match == nil then
match = string.match(line, "]*>(.+)")
end
-- if we have one, compute the path of the file, and add it to the dependencies
-- note : the QRC files are relative to the folder containing the qrc file.
if match ~= nil then
table.insert(dependencies, path.getrelative(projectdirectory, qrcdirectory .. "/" .. match))
end
end
-- close the qrc file
io.close(file)
end
return dependencies
end
--
-- Checks if a file needs moc'ing.
--
-- @param filename
-- The file name to check.
-- @return
-- true if the header needs to be run through the moc tool, false if not.
--
function premake.extensions.qt.needMOC(filename)
local needmoc = false
-- only handle headers
if path.iscppheader(filename) then
-- open the file
local file = io.open(filename)
if file ~= nil then
-- scan it to find 'Q_OBJECT' or 'Q_GADGET'
for line in file:lines() do
if line:find("^%s*Q_OBJECT%f[^%w_]") or line:find("^%s*Q_GADGET%f[^%w_]") then
needmoc = true
break
end
end
io.close(file)
end
end
return needmoc
end
--
-- Adds the custom build for a moc'able file.
--
-- @param fcfg
-- The config for a single file.
-- @param cfg
-- The config of the project ?
--
function premake.extensions.qt.addMOCCustomBuildRule(fcfg, cfg)
local qt = premake.extensions.qt
-- get the project's location (to make paths relative to it)
local projectloc = fcfg.project.location
-- create the output file name
local output = qt.getGeneratedDir(cfg) .. "/moc_" .. fcfg.basename .. ".cpp"
-- create the moc command
local command = "\"" .. fcfg.config.qtbinpath .. "/moc\" \"" .. fcfg.relpath .. "\""
command = command .. " -o \"" .. path.getrelative(projectloc, output) .. "\""
-- if we have a precompiled header, prepend it
if fcfg.config.pchheader then
command = command .. " -b \"" .. fcfg.config.pchheader .. "\""
end
-- now create the arguments
local arguments = ""
-- append the defines to the arguments
if #fcfg.config.defines > 0 then
table.foreachi(fcfg.config.defines, function (define)
arguments = arguments .. " -D" .. define
end)
end
-- append the include directories to the arguments
if #fcfg.config.includedirs > 0 then
table.foreachi(fcfg.config.includedirs, function (include)
arguments = arguments .. " -I\"" .. path.getrelative(projectloc, include) .. "\""
end)
end
-- if we have custom commands, add them
if fcfg.config.qtmocargs then
table.foreachi(fcfg.config.qtmocargs, function (arg)
arguments = arguments .. " \"" .. arg .. "\""
end)
end
-- handle the command line size limit
command = qt.handleCommandLineSizeLimit(cfg, fcfg, command, arguments)
-- add the custom build rule
fcfg.buildmessage = "Moc'ing " .. fcfg.name
fcfg.buildcommands = { command }
fcfg.buildoutputs = { output }
end
--
-- Checks if the command line will exceed the given size limit, and will output
-- the arguments to a file if so. The updated command is returned
--
-- @param cfg
-- The configuration object.
-- @param fcfg
-- The file configuration object.
-- @param command
-- The command.
-- @param arguments
-- The arguments.
-- @return
-- The updated command.
--
function premake.extensions.qt.handleCommandLineSizeLimit(cfg, fcfg, command, arguments)
-- check if we need to output to a file
local limit = fcfg.config.qtcommandlinesizelimit or iif(_TARGET_OS == "windows", 2047, nil)
if limit ~= nil and string.len(command) + string.len(arguments) + 1 > limit then
local qt = premake.extensions.qt
-- create the argument file name
local filename = qt.getGeneratedDir(cfg) .. "/moc_" .. fcfg.basename .. ".args"
-- output the arguments to it
local file = io.open(filename, "w")
file:write(arguments)
io.close(file)
-- update the command to load this file
return command .. " @\"" .. filename .. "\""
end
-- update the command to include the arguments
return command .. " " .. arguments
end
--
-- Merge defines into the configuration, taking care of not adding the
-- same define twice.
--
-- @param config
-- The configuration object.
-- @param defines
-- The defines to add.
--
function premake.extensions.qt.mergeDefines(config, defines)
-- a function which checks if a value is contained in a table.
local contains = function (t, v)
for _, d in ipairs(t) do
if d == v then
return true
end
end
return false
end
-- ensure defines is a table
if type(defines) ~= "table" then
defines = { defines }
end
-- add each defines
for _, define in ipairs(defines) do
if contains(config.defines, define) == false then
table.insert(config.defines, define)
end
end
end
--
-- Get the include dir for the given module.
--
-- @param config
-- The current config.
-- @param module
-- The module.
-- @return
-- The include dir.
--
function premake.extensions.qt.getIncludeDir(config, module)
if _TARGET_OS == "macosx" then
return path.join(config.qtlibpath, module.include .. ".framework", "Headers")
else
return path.join(config.qtincludepath, module.include)
end
end