add find_tool

2 files changed, 88 insertions, 6 deletions

diff --git a/xmake/core/sandbox/modules/import/lib/detect/find_program.lua b/xmake/core/sandbox/modules/import/lib/detect/find_program.lua
index a14b67648..2b4b6c4fa 100644
--- a/xmake/core/sandbox/modules/import/lib/detect/find_program.lua
+++ b/xmake/core/sandbox/modules/import/lib/detect/find_program.lua
@@ -123,7 +123,7 @@ end
 -- find program
 --
 -- @param name      the program name
--- @param pathes    the program pathes (.e.g dirs, pathes, winreg pathes)
+-- @param pathes    the program pathes (.e.g dirs, pathes, winreg pathes, script pathes)
 -- @param check     the check script or command 
 --
 -- @return          the program name or path
@@ -131,11 +131,11 @@ end
 -- @code
 --
 -- local program = find_program("ccache")
--- local program = find_program("ccache", { "/usr/bin", "/usr/local/bin"})
--- local program = find_program("ccache", { "/usr/bin", "/usr/local/bin"}, "--help") -- simple check command: ccache --help
--- local program = find_program("ccache", { "/usr/bin", "/usr/local/bin"}, function (program) os.run("%s -h", program) end)
--- local program = find_program("ccache", { "$(env PATH)", "$(reg HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug;Debugger)"})
--- local program = find_program("ccache", { "$(env PATH)", function () return val("HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug;Debugger"):match("\"(.-)\"") end})
+-- local program = find_program("ccache", {"/usr/bin", "/usr/local/bin"})
+-- local program = find_program("ccache", {"/usr/bin", "/usr/local/bin"}, "--help") -- simple check command: ccache --help
+-- local program = find_program("ccache", {"/usr/bin", "/usr/local/bin"}, function (program) os.run("%s -h", program) end)
+-- local program = find_program("ccache", {"$(env PATH)", "$(reg HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug;Debugger)"})
+-- local program = find_program("ccache", {"$(env PATH)", function () return "/usr/local/bin" end})
 --
 -- @endcode
 --
diff --git a/xmake/modules/lib/detect/find_tool.lua b/xmake/modules/lib/detect/find_tool.lua
new file mode 100644
index 000000000..9d4a54635
--- /dev/null
+++ b/xmake/modules/lib/detect/find_tool.lua
@@ -0,0 +1,82 @@
+--!The Make-like Build Utility based on Lua
+--
+-- Licensed to the Apache Software Foundation (ASF) under one
+-- or more contributor license agreements.  See the NOTICE file
+-- distributed with this work for additional information
+-- regarding copyright ownership.  The ASF licenses this file
+-- to you under the Apache License, Version 2.0 (the
+-- "License"); you may not use this file except in compliance
+-- with the License.  You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+-- 
+-- Copyright (C) 2015 - 2017, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        find_tool.lua
+--
+
+-- imports
+import("lib.detect.find_program")
+import("lib.detect.find_programver")
+
+-- find tool from modules
+function _find_from_modules(name, opt)
+
+    -- "detect.tool.find_xxx" exists?
+    if os.isfile(path.join(os.programdir(), "modules", "detect", "tool", "find_" .. name .. ".lua")) then
+        local find_tool = import("detect.tool.find_" .. name, {anonymous = true})
+        if find_tool then
+            return find_tool(opt)
+        end
+    end
+end
+
+-- find tool
+--
+-- @param name      the tool name
+-- @param opt       the options, .e.g {pathes = {"/usr/bin"}, check = function (tool) os.run("%s -h", tool) end, version = true}
+--
+-- @return          the tool name or path, version
+--
+-- @code
+--
+-- local tool = find_tool("ccache")
+-- local tool = find_tool("ccache", {pathes = {"/usr/bin", "/usr/local/bin"}})
+-- local tool = find_tool("ccache", {check= "--help"}) -- simple check command: ccache --help
+-- local tool = find_tool("ccache", {check = function (tool) os.run("%s -h", tool) end})
+-- local tool = find_tool("ccache", {pathes = {"$(env PATH)", "$(reg HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug;Debugger)"}})
+-- local tool = find_tool("ccache", {pathes = {"$(env PATH)", function () return "/usr/bin"end}})
+-- local tool, version = find_tool("ccache", {version = true})
+--
+-- @endcode
+--
+function main(name, opt)
+
+    -- init options
+    opt = opt or {}
+
+    -- attempt to find tool from modules first
+    local tool, version = _find_from_modules(name, opt)
+    if tool then
+        return tool, version
+    end
+ 
+    -- find tool
+    tool = find_program(name, opt.pathes, opt.check)
+
+    -- find tool version
+    local version = nil
+    if tool and opt.version then
+        version = find_programver(tool)
+    end
+
+    -- ok?
+    return tool, version
+end