path: root/xmake/scripts/base/makefile.lua

--!The Automatic Crmakefiles-platform Build Tool
-- 
-- XMake is free software; you can redistribute it and/or modify
-- it under the terms of the GNU Lesser General Public License as published by
-- the Free Software Foundation; either version 2.1 of the License, or
-- (at your option) any later version.
-- 
-- XMake is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU Lesser General Public License for more details.
-- 
-- You should have received a copy of the GNU Lesser General Public License
-- along with XMake; 
-- If not, see <a href="http://www.gnu.org/licenses/"> http://www.gnu.org/licenses/</a>
-- 
-- Copyright (C) 2009 - 2015, ruki All rights reserved.
--
-- @author      ruki
-- @file        makefile.lua
--

-- define module: makefile
local makefile = makefile or {}

-- load modules
local io        = require("base/io")
local os        = require("base/os")
local path      = require("base/path")
local utils     = require("base/utils")
local config    = require("base/config")
local project   = require("base/project")
local platform  = require("platform/platform")

-- get the linker from the given kind
function makefile._linker(kind)
        
    -- init linkers
    makefile._LINKERS = makefile._LINKERS or {}
    local linkers = makefile._LINKERS

    -- return it directly if the linker has been cached
    local l = linkers[kind]
    if l then return l end

    -- get compiler from the current platform
    l = platform.linker(kind)

    -- cache this compiler
    linkers[kind] = l

    -- ok
    return l
end

-- get the compiler from the given source file
function makefile._compiler(srcfile)

    -- get the source file type
    local filetype = path.extension(srcfile)
    if not filetype then
        return nil, string.format("cannot get the source file type: %s", srcfile)
    end

    -- get the lower file type
    filetype = filetype:lower()

    -- get the compiler name
    local name = nil
    if filetype == ".c" then name = "cc"
    elseif filetype == ".cpp" or filetype == ".cc" then name = "cxx"
    elseif filetype == ".m" then name = "mm"
    elseif filetype == ".mm" then name = "mxx"
    elseif filetype == ".s" or filetype == ".asm" then name = "as"
    else return nil, string.format("unknown file type: %s", filetype)
    end
    
    -- init compilers
    makefile._COMPILERS = makefile._COMPILERS or {}
    local compilers = makefile._COMPILERS

    -- return it directly if the compiler has been cached
    local c = compilers[name]
    if c then return c end

    -- get compiler from the current platform
    c = platform.compiler(name)

    -- cache this compiler
    compilers[name] = c

    -- ok
    return c
end

-- get the source files from the given target
function makefile._srcfiles(target)

    -- check
    assert(target)

    -- no files?
    if not target.files then
        return {}
    end

    -- wrap files first
    local target_files = utils.wrap(target.files)

    -- match files
    local i = 1
    local srcfiles = {}
    for _, target_file in ipairs(target_files) do

        -- match source files
        local files = os.match(target_file)

        -- process source files
        for _, file in ipairs(files) do

            -- convert to the relative path
            if path.is_absolute(file) then
                file = path.relative(file, xmake._PROJECT_DIR)
            end

            -- save it
            srcfiles[i] = file
            i = i + 1

        end
    end

    -- remove repeat files
    srcfiles = utils.unique(srcfiles)

    -- ok?
    return srcfiles
end

-- get object files for the given source files
function makefile._objfiles(name, srcfiles)

    -- check
    assert(name and srcfiles)

    -- the build directory
    local buildir = config.get("buildir")
    assert(buildir)
   
    -- make object files
    local i = 1
    local objfiles = {}
    for _, srcfile in ipairs(srcfiles) do

        -- make object file
        local objfile = string.format("%s/%s/%s/%s", buildir, name, path.directory(srcfile), platform.filename(path.basename(srcfile), "object"))

        -- save it
        objfiles[i] = path.translate(objfile)
        i = i + 1

    end

    -- ok?
    return objfiles
end

-- get target file for the given target name and kind
function makefile._targetfile(name, kind)

    -- check
    assert(name and kind)

    -- the build directory
    local buildir = config.get("buildir")
    assert(buildir)
   
    -- the target file name
    local filename = platform.filename(name, kind)
    assert(filename)

    -- make the target file path
    return buildir .. "/" .. name .. "/" .. filename
end

-- make the object to the makefile
function makefile._make_object(file, target, srcfile, objfile)
    
    -- check
    assert(file and target and srcfile and objfile)

    -- get the compiler
    local c, errors = makefile._compiler(srcfile);
    if not c then
        -- error
        utils.error(errors)
        return false
    end

    -- make head
    file:write(string.format("%s:", objfile))

    -- make dependence
    file:write(string.format(" %s\n", srcfile))

    -- make body
    file:write(string.format("\t@echo [%s]: compiling %s\n", config.get("mode"), srcfile))
    file:write(string.format("\t@xmake l mkdir %s\n", path.directory(objfile)))
    file:write(string.format("\t@%s\n", c:make(srcfile, objfile, "")))

    -- make tail
    file:write("\n")

    -- ok
    return true
end

-- make all objects of the given target to the makefile
function makefile._make_objects(file, target, srcfiles, objfiles)

    -- check
    assert(file and target and srcfiles and objfiles)

    -- make all objects
    local i = 1
    for _, objfile in ipairs(objfiles) do

        -- make object
        if not makefile._make_object(file, target, srcfiles[i], objfile) then
            return false
        end

        -- next
        i = i + 1
    end

    -- ok
    return true
end

-- make the given target to the makefile
function makefile._make_target(file, name, target)

    -- check
    assert(file and name and target and target.kind)

    -- get source and object files
    local srcfiles = makefile._srcfiles(target)
    local objfiles = makefile._objfiles(name, srcfiles)
    assert(srcfiles and objfiles)

    -- get target file
    local targetfile = makefile._targetfile(name, target.kind)
    assert(targetfile)

    -- the linker
    local l = makefile._linker(target.kind)
    assert(l)

    -- the make command
    local make_command = l["make_" .. target.kind]
    if not make_command then
        -- error
        utils.error("the target kind: %s in not surpported now!", target.kind)
        return false
    end

    -- make head
    file:write(string.format("%s:", name))

    -- make dependence for the dependent targets
    if target.deps then
        local deps = utils.wrap(target.deps)
        for _, dep in ipairs(deps) do
            file:write(" " .. dep)
        end
    end

    -- make dependence for objects
    for _, objfile in ipairs(objfiles) do
        file:write(" " .. objfile)
    end

    -- make dependence end
    file:write("\n")

    -- make body
    file:write(string.format("\t@echo [%s]: linking %s\n", config.get("mode"), path.filename(targetfile)))
    file:write(string.format("\t@xmake l mkdir %s\n", path.directory(targetfile)))
    file:write(string.format("\t@%s\n", make_command(l, objfiles, targetfile, "")))

    -- make tail
    file:write("\n")

    -- make objects for this target
    return makefile._make_objects(file, target, srcfiles, objfiles) 
end

-- make all targets to the makefile
function makefile._make_targets(file)

    -- check 
    assert(file)

    -- get all project targets
    local targets = project.targets()
    if not targets then
        -- error
        utils.error("not found target in this project!")
        return false
    end

    -- make all first
    local all = ""
    for name, _ in pairs(targets) do
        -- append the target name to all
        all = all .. " " .. name
    end
    file:write(string.format("all: %s\n\n", all))

    -- make it for all targets
    for name, target in pairs(targets) do
        -- make target
        if not makefile._make_target(file, name, target) then
            -- error
            utils.error("failed to make target %s to makefile!", name)
            return false
        end

        -- append the target name to all
        all = all .. " " .. name
    end
   
    -- ok
    return true
end

-- make makefile in the build directory
function makefile.make()

    -- get the build directory
    local buildir = config.get("buildir")
    assert(buildir)

    -- make the build directory
    if not os.isdir(buildir) then
        assert(os.mkdir(buildir))
    end

    -- open the makefile 
    local path = buildir .. "/makefile"
    local file = io.open(path, "w")
    if not file then
        -- error
        utils.error("open %s failed!", path)
        return false
    end

    -- make all targets to the makefile
    if not makefile._make_targets(file) then

        -- error 
        utils.error("save %s failed!", path)

        -- close the makefile
        file:close()

        -- remove the makefile
        os.rm(path)

        -- failed
        return false
    end

    -- close the makefile
    file:close()

    -- ok
    return true
end

-- build target
function makefile.build(target)

    -- check
    assert(target and type(target) == "string")

    -- get the build directory
    local buildir = config.get("buildir")
    assert(buildir)

    -- done build
    local ok = os.execute(string.format("make -f %s %s", buildir .. "/makefile", target))
    if ok ~= 0 then
        -- error
        utils.error("build target: %s failed!", target)
        return false
    end

    -- ok
    return true
end

-- return module: makefile
return makefile