Source

premake for usage / src / base / action.lua

Full commit
--
-- action.lua
-- Work with the list of registered actions.
-- Copyright (c) 2002-2009 Jason Perkins and the Premake project
--

	premake.action = { }


--
-- The list of registered actions.
--

	premake.action.list = { }
	

--
-- Register a new action.
--
-- @param a
--    The new action object.
-- 

	function premake.action.add(a)
		-- validate the action object, at least a little bit
		local missing
		for _, field in ipairs({"description", "trigger"}) do
			if (not a[field]) then
				missing = field
			end
		end
		
		if (missing) then
			error("action needs a " .. missing, 3)
		end

		-- add it to the master list
		premake.action.list[a.trigger] = a		
	end


--
-- Trigger an action.
--
-- @param name
--    The name of the action to be triggered.
-- @returns
--    None.
--

	function premake.action.call(name)
		local a = premake.action.list[name]

		-- a bit of a hack, but check for the new next-gen actions, and
		-- translate things accordingly. I'll yank this once the next-gen
		-- actions are done and official
		if a.isnextgen then
			if _ACTION:endswith("ng") then
				_ACTION = _ACTION:sub(1, -3)
			end
			for sln in premake.solution.each() do
				if a.onsolution then
					a.onsolution(sln)
				end
				for prj in premake.solution.eachproject_ng(sln) do
					if a.onproject and not prj.external then
						a.onproject(prj)
					end
				end
			end
		else
			for sln in premake.solution.each() do
				if a.onsolution then
					a.onsolution(sln)
				end
				for prj in premake.solution.eachproject(sln) do
					if a.onproject and not prj.external then
						a.onproject(prj)
					end
				end
			end
		end
				
		if a.execute then
			a.execute()
		end
	end


--
-- Retrieve the current action, as determined by _ACTION.
--
-- @return
--    The current action, or nil if _ACTION is nil or does not match any action.
--

	function premake.action.current()
		return premake.action.get(_ACTION)
	end
	
	
--
-- Retrieve an action by name.
--
-- @param name
--    The name of the action to retrieve.
-- @returns
--    The requested action, or nil if the action does not exist.
--

	function premake.action.get(name)
		-- "Next-gen" actions are deprecated
		if name:endswith("ng") then
			name = name:sub(1, -3)
		end

		return premake.action.list[name]
	end


--
-- Iterator for the list of actions.
--

	function premake.action.each()
		-- sort the list by trigger
		local keys = { }
		for _, action in pairs(premake.action.list) do
			table.insert(keys, action.trigger)
		end
		table.sort(keys)
		
		local i = 0
		return function()
			i = i + 1
			return premake.action.list[keys[i]]
		end
	end


--
-- Activates a particular action.
--
-- @param name
--    The name of the action to activate.
--

	function premake.action.set(name)
		_ACTION = name
		
		-- Some actions imply a particular operating system
		local action = premake.action.get(name)
		if action then
			_OS = action.os or _OS
		end
	end


--
-- Determines if an action supports a particular language or target type.
--
-- @param action
--    The action to test.
-- @param feature
--    The feature to check, either a programming language or a target type.
-- @returns
--    True if the feature is supported, false otherwise.
--

	function premake.action.supports(action, feature)
		if not action then
			return false
		end
		if action.valid_languages then
			if table.contains(action.valid_languages, feature) then
				return true
			end
		end
		if action.valid_kinds then
			if table.contains(action.valid_kinds, feature) then
				return true
			end
		end
		return false
	end


--
-- Determines if an action supports a particular configuration.
-- @return
--    True if the configuration is supported, false otherwise.
--

	function premake.action.supportsconfig(action, cfg)
		if not action then
			return false
		end
		
		if action.supportsconfig then
			return action.supportsconfig(cfg)
		end
		
		return true
	end