AuroraPipeline/premake
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 1 Wiki Activity

[core] get file/line information on deprecated API's.

Browse Source
This commit is contained in:
Tom van Dijck 2017-04-27 16:13:59 -07:00
parent 127fe78e14
commit 2c74dbee95
3 changed files with 33 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/base/_foundation.lua
View File

@ -376,3 +376,19 @@
print(string.format(msg, ...))
end
end
--
-- make a string from debug.getinfo information.
--
function filelineinfo(level)
local info = debug.getinfo(level+1, "Sl")
if info == nil then
return nil
end
if info.what == "C" then
return "C function"
else
return string.format("%s(%d)", info.short_src, info.currentline)
end
end

20
src/base/api.lua
View File

@ -490,8 +490,12 @@
if field.deprecated and type(field.deprecated.handler) == "function" then
field.deprecated.handler(value)
if field.deprecated.message and api._deprecations ~= "off" then
p.warnOnce(field.name, "the field %s has been deprecated and will be removed.\n %s", field.name, field.deprecated.message)
if api._deprecations == "error" then error("deprecation errors enabled", 3) end
local caller = filelineinfo(2)
local key = field.name .. "_" .. caller
p.warnOnce(key, "the field %s has been deprecated and will be removed.\n %s\n @%s\n", field.name, field.deprecated.message, caller)
if api._deprecations == "error" then
error("deprecation errors enabled", 3)
end
end
end
@ -536,13 +540,14 @@
local removes = {}
function check(value)
local function check(value)
if field.deprecated[value] then
local handler = field.deprecated[value]
if handler.remove then handler.remove(value) end
if handler.message and api._deprecations ~= "off" then
local key = field.name .. "_" .. value
p.warnOnce(key, "the %s value %s has been deprecated and will be removed.\n %s", field.name, value, handler.message)
local caller = filelineinfo(8)
local key = field.name .. "_" .. value .. "_" .. caller
p.warnOnce(key, "the %s value %s has been deprecated and will be removed.\n %s\n @%s\n", field.name, value, handler.message, caller)
if api._deprecations == "error" then
error { msg="deprecation errors enabled" }
end
@ -647,8 +652,9 @@
local handler = field.deprecated[canonical]
handler.add(canonical)
if handler.message and api._deprecations ~= "off" then
local key = field.name .. "_" .. value
p.warnOnce(key, "the %s value %s has been deprecated and will be removed.\n %s", field.name, canonical, handler.message)
local caller = filelineinfo(9)
local key = field.name .. "_" .. value .. "_" .. caller
p.warnOnce(key, "the %s value %s has been deprecated and will be removed.\n %s\n @%s\n", field.name, canonical, handler.message, caller)
if api._deprecations == "error" then
return nil, "deprecation errors enabled"
end

6
src/base/os.lua
View File

@ -143,7 +143,8 @@
end
function os.get()
premake.warnOnce("os.get", "os.get() is deprecated, use 'os.target()' or 'os.host()'.")
local caller = filelineinfo(2)
premake.warnOnce(caller, "os.get() is deprecated, use 'os.target()' or 'os.host()'.\n @%s\n", caller)
return os.target()
end
@ -180,7 +181,8 @@
end
function os.is(id)
premake.warnOnce("os.is", "os.is() is deprecated, use 'os.istarget()' or 'os.ishost()'.")
local caller = filelineinfo(2)
premake.warnOnce(caller, "os.is() is deprecated, use 'os.istarget()' or 'os.ishost()'.\n @%s\n", caller)
return os.istarget(id)
end