xcode_utils.lua

--
-- xcode6_utils.lua
-- Define the Apple XCode action and support functions.
-- Copyright (c) 2015 Blizzard Entertainment
--

	local p         = premake
	local api       = p.api
	local configset = p.configset
	local context   = p.context
	local detoken   = p.detoken
	local xcode6    = p.modules.xcode_blizzard
	local project   = p.project
	local workspace = p.workspace


	function xcode6.newid(...)
		local name = table.concat({...}, ';');
		return string.sub(name:sha1(), 1, 24)
	end


	function xcode6.getBuildCategory(filename)
		if not xcode6._buildCategories then
			local categories = {
				[".a"] = "Frameworks",
				[".app"] = "Applications",
				[".c"] = "Sources",
				[".cc"] = "Sources",
				[".cpp"] = "Sources",
				[".cxx"] = "Sources",
				[".dylib"] = "Frameworks",
				[".framework"] = "Frameworks",
				[".m"] = "Sources",
				[".metal"] = "Sources",
				[".mig"] = "Sources",
				[".mm"] = "Sources",
				[".strings"] = "Resources",
				[".nib"] = "Resources",
				[".xib"] = "Resources",
				[".icns"] = "Resources",
				[".s"] = "Sources",
				[".storyboard"] = "Resources",
				[".txt"] = "Resources"
			}

			for rule in p.global.eachRule() do
				for _, v in ipairs(rule.fileextension) do
					categories[v] = "Sources"
				end
			end

			xcode6._buildCategories = categories
		end

		return xcode6._buildCategories[string.lower(path.getextension(filename))]
	end


	function xcode6.getProductType(prj)
		if prj.kind == "SharedLib" and prj.sharedlibtype then
			local types = {
				OSXBundle = "com.apple.product-type.bundle",
				OSXFramework = "com.apple.product-type.framework",
			}
			return types[prj.sharedlibtype]
		else
			local types = {
				ConsoleApp  = iif(os.istarget("macosx"), "com.apple.product-type.tool", "com.apple.product-type.application"),
				WindowedApp = "com.apple.product-type.application",
				StaticLib   = "com.apple.product-type.library.static",
				SharedLib   = "com.apple.product-type.library.dynamic",
			}
			return types[prj.kind]
		end
	end


	function xcode6.getTargetType(prj)
		local types = {
			ConsoleApp  = "\"compiled.mach-o.executable\"",
			WindowedApp = "wrapper.application",
			StaticLib   = "archive.ar",
			SharedLib   = "\"compiled.mach-o.dylib\"",
		}
		return types[prj.kind]
	end


	function xcode6.getTargetName(prj, cfg)
		if prj.external then
			return cfg.project.name
		end
		return cfg.buildtarget.bundlename ~= "" and cfg.buildtarget.bundlename or cfg.buildtarget.name;
	end


	function xcode6.isItemResource(project, node)
		local res;
		if project and project.xcodebuildresources and type(project.xcodebuildresources) == "table" then
			res = project.xcodebuildresources
		end

		local function checkItemInList(item, list)
			if item and list and type(list) == "table" then
				for _,v in pairs(list) do
					if string.find(item, v) then
						return true
					end
				end
			end
			return false
		end

		return checkItemInList(node.path, res);
	end


	function xcode6.getFrameworkDirs(cfg)
		local done = {}
		local dirs = {}

		if cfg.project then
			table.foreachi(cfg.links, function(link)
				if link:find('.framework$') and path.isabsolute(link) then
					local dir = workspace.getrelative(cfg.workspace, path.getdirectory(link))
					if not done[dir] then
						table.insert(dirs, dir)
						done[dir] = true
					end
				end
			end)
		end

		local frameworkdirs = xcode6.fetchlocal(cfg, 'xcode_frameworkdirs')
		if frameworkdirs then
			table.foreachi(frameworkdirs, function(dir)
				if path.isabsolute(dir) then
					dir = workspace.getrelative(cfg.workspace, dir)
				end
				if not done[dir] then
					table.insert(dirs, dir)
					done[dir] = true
				end
			end)
		end

		return dirs
	end

	local escapeSpecialChars = {
		['\n'] = '\\n',
		['\r'] = '\\r',
		['\t'] = '\\t',
	}


	local function escapeChar(c)
		return escapeSpecialChars[c] or '\\'..c
	end


	local function escapeArg(value)
		value = value:gsub('[\'"\\\n\r\t ]', escapeChar)
		return value
	end


	function xcode6.esc(value)
		value = value:gsub('["\\\n\r\t]', escapeChar)
		return value
	end


	function xcode6.quoted(value)
		value = value..''
		if not value:match('^[%a%d_./]+$') then
			value = '"' .. xcode6.esc(value) .. '"'
		end
		return value
	end


	function xcode6.filterEmpty(dirs)
		return table.translate(dirs, function(val)
			if val and #val > 0 then
				return val
			else
				return nil
			end
		end)
	end


	function xcode6.printSetting(level, name, value)
		if type(value) == 'function' then
			value(level, name)
		elseif type(value) ~= 'table' then
			_p(level, '%s = %s;', xcode6.quoted(name), xcode6.quoted(value))
		elseif #value == 1 then
			_p(level, '%s = %s;', xcode6.quoted(name), xcode6.quoted(value[1]))
		elseif #value > 1 then
			_p(level, '%s = (', xcode6.quoted(name))
			for _, item in ipairs(value) do
				_p(level + 1, '%s,', xcode6.quoted(item))
			end
			_p(level, ');')
		end
	end


	function xcode6.printSettingsTable(level, settings)
		-- Maintain alphabetic order to be consistent
		local keys = table.keys(settings)
		table.sort(keys)
		for _, k in ipairs(keys) do
			xcode6.printSetting(level, k, settings[k])
		end
	end


	function xcode6.fetchlocal(cfg, key)
		-- if cfg is nil just exit.
		if cfg == nil then
			return nil
		end

		-- If there's no field definition, just return the raw value.
		local field = p.field.get(key)
		if not field then
			return cfg[key]
		end

		local wks = cfg.workspace
		local prj = cfg.project

		-- If it's a workspace config, just fetch the value normally.
		if not prj then
			local value = cfg[key]
			return value, value, { }	-- everything is new
		end

		-- If it's a project config, then we only want values specified at the project or configuration level,
		-- or with an explicit filter for the project or configuration. If it's a file config, then we only
		-- want values with an explicit filter for the file.
		local value = nil
		local inserted = nil
		local removed = nil
		local parentcfg = cfg.buildcfg and table.filter(wks.configs, function(_cfg) return _cfg.name == cfg.name end)[1]
		local parent = parentcfg or (cfg.terms.files and prj or wks)
		if p.field.removes(field) then
			value = cfg[key]
			if value then
				if cfg.abspath then
					-- files don't automatically inherit settings from projects, so handle that here
					value = p.field.merge(field, xcode6.fetchfiltered(parent, field, cfg.terms), value)
				end
				local parentvalue = parent[key]
				inserted = { }
				removed = { }
				for _, v in ipairs(parentvalue) do
					if not value[v] then
						table.insert(removed, v)
					end
				end
				for _, v in ipairs(value) do
					if not parentvalue[v] then
						table.insert(inserted, v)
					end
				end
			end
		elseif p.field.merges(field) then
			value = cfg[key]
			if value then
				if cfg.abspath then
					-- files don't automatically inherit settings from projects, so handle that here
					value = p.field.merge(field, xcode6.fetchfiltered(parent, field, cfg.terms), value)
				end
				local slnvalue = context.fetchvalue(parent, key)
				local parentvalue = xcode6.fetchfiltered(cfg, field, cfg.terms)
				inserted = { }
				for _, v in ipairs(parentvalue) do
					if not slnvalue[v] then
						table.insert(inserted, v)
					end
				end
				inserted = p.field.merge(field, inserted, context.fetchvalue(prj, key, true))
				inserted = p.field.merge(field, inserted, xcode6.fetchfiltered(cfg, field, cfg.terms, prj))
				inserted = p.field.merge(field, inserted, context.fetchvalue(cfg, key, true))
				removed = { }
			end
		else
			value = context.fetchvalue(cfg, key, true)
			if value == nil then
				value = xcode6.fetchfiltered(cfg, field, cfg.terms, prj)
				if value == nil then
					value = context.fetchvalue(prj, key, true)
					if value == nil then
						local parentvalue = xcode6.fetchfiltered(cfg, field, cfg.terms)
						local slnvalue = context.fetchvalue(parent, key)
						if slnvalue ~= parentvalue then
							value = parentvalue
						end
					end
				end
			end
		end

		return value, inserted, removed
	end


	function xcode6.fetchfiltered(cfg, field, terms, ctx)
		return configset.fetch(cfg._cfgset, field, terms, cfg, ctx and ctx._cfgset)
	end


	function xcode6.resolveShellScript(wks, prj, cmd)
		local userDefinedCommands = os.translateCommandsAndPaths(cmd, prj.basedir, wks.location)
		return 'PATH=$EXECUTABLE_PATHS:$PATH\n' .. userDefinedCommands
	end


	function xcode6.buildOutputsEnvironment(rule)
		local pathVars = p.rule.createPathVars(rule, "$(%s)")
		pathVars["file.basename"]     = { absolute = false, token = "$(INPUT_FILE_BASE)" }
		pathVars["file.abspath"]      = { absolute = true,  token = "$(INPUT_FILE_PATH)" }
		pathVars["file.relpath"]      = { absolute = true,  token = "$(INPUT_FILE_PATH)" }
		pathVars["file.path"]         = { absolute = true,  token = "$(INPUT_FILE_PATH)" }
		pathVars["file.directory"]    = { absolute = true,  token = "$(INPUT_FILE_DIR)" }
		pathVars["file.reldirectory"] = { absolute = true,  token = "$(INPUT_FILE_DIR)" }

		return context.extent(rule, { pathVars = pathVars })
	end

	function xcode6.buildCommandsEnvironment(rule)
		local pathVars = {}
		pathVars["file.basename"]     = { absolute = false, token = "$INPUT_FILE_BASE" }
		pathVars["file.abspath"]      = { absolute = true,  token = "$INPUT_FILE_PATH" }
		pathVars["file.relpath"]      = { absolute = true,  token = "$INPUT_FILE_PATH" }
		pathVars["file.path"]         = { absolute = true,  token = "$INPUT_FILE_PATH" }
		pathVars["file.directory"]    = { absolute = true,  token = "$INPUT_FILE_DIR" }
		pathVars["file.reldirectory"] = { absolute = true,  token = "$INPUT_FILE_DIR" }

		local environ = p.rule.createEnvironment(rule, "$%s")
		environ.pathVars = pathVars

		return context.extent(rule, environ)
	end


	function xcode6.path(wks, prefix, filename)
		if type(filename) == "table" then
			local result = {}
			for i, name in ipairs(filename) do
				if name and #name > 0 then
					table.insert(result, xcode6.path(wks, prefix, name))
				end
			end
			return result
		else
			if filename then
				return path.join(prefix, path.getrelative(wks.location, filename))
			end
		end
	end