From 35aeaac3f956f26f188ebab40c443b64d2cb2f95 Mon Sep 17 00:00:00 2001 From: ruki Date: Sun, 7 Dec 2025 15:27:27 +0800 Subject: move bin2obj and bin2c modules --- xmake/modules/private/utils/bin2c.lua | 129 ------------------------ xmake/modules/private/utils/bin2obj.lua | 170 -------------------------------- xmake/modules/utils/binary/bin2c.lua | 130 ++++++++++++++++++++++++ xmake/modules/utils/binary/bin2obj.lua | 170 ++++++++++++++++++++++++++++++++ xmake/rules/utils/bin2c/xmake.lua | 2 +- xmake/rules/utils/bin2obj/xmake.lua | 2 +- xmake/rules/utils/glsl2spv/xmake.lua | 2 +- xmake/rules/utils/hlsl2spv/xmake.lua | 2 +- xmake/rules/xmake_cli/xmake.lua | 2 +- 9 files changed, 305 insertions(+), 304 deletions(-) delete mode 100644 xmake/modules/private/utils/bin2c.lua delete mode 100644 xmake/modules/private/utils/bin2obj.lua create mode 100644 xmake/modules/utils/binary/bin2c.lua create mode 100644 xmake/modules/utils/binary/bin2obj.lua diff --git a/xmake/modules/private/utils/bin2c.lua b/xmake/modules/private/utils/bin2c.lua deleted file mode 100644 index 0d6f06a1d..000000000 --- a/xmake/modules/private/utils/bin2c.lua +++ /dev/null @@ -1,129 +0,0 @@ ---!A cross-platform build utility based on Lua --- --- Licensed 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-present, Xmake Open Source Community. --- --- @author ruki --- @file bin2c.lua --- - --- imports -import("core.base.bytes") -import("core.base.option") - -local options = { - {'w', "linewidth", "kv", nil, "Set the line width"}, - {nil, "nozeroend", "k", false, "Disable to patch zero terminating character"}, - {'i', "binarypath", "kv", nil, "Set the binary file path."}, - {'o', "outputpath", "kv", nil, "Set the output file path."} -} - -function _do_dump(binarydata, outputfile, opt) - local i = 0 - local n = 147 - local p = 0 - local e = binarydata:size() - local line = nil - local linewidth = opt.linewidth or 32 - local first = true - while p < e do - line = "" - if p + linewidth <= e then - for i = 0, linewidth - 1 do - if first then - first = false - line = line .. " " - else - line = line .. "," - end - line = line .. string.format(" 0x%02X", binarydata[p + i + 1]) - end - outputfile:print(line) - p = p + linewidth - elseif p < e then - local left = e - p - for i = 0, left - 1 do - if first then - first = false - line = line .. " " - else - line = line .. "," - end - line = line .. string.format(" 0x%02X", binarydata[p + i + 1]) - end - outputfile:print(line) - p = p + left - else - break - end - end -end - -function _do_bin2c(binarypath, outputpath, opt) - - -- init source directory and options - opt = opt or {} - binarypath = path.absolute(binarypath) - outputpath = path.absolute(outputpath) - assert(os.isfile(binarypath), "%s not found!", binarypath) - - -- trace - print("generating code data file from %s ..", binarypath) - - -- optimize the default linewidth for reading large file - if not opt.linewidth then - local filesize = os.filesize(binarypath) - if filesize > 1024 * 1024 * 1024 then - opt.linewidth = 512 - elseif filesize > 100 * 1024 * 1024 then - opt.linewidth = 256 - elseif filesize > 10 * 1024 * 1024 then - opt.linewidth = 128 - elseif filesize > 1024 * 1024 then - opt.linewidth = 64 - else - opt.linewidth = 32 - end - end - - -- do dump - if utils.bin2c then - utils.bin2c(binarypath, outputpath, opt) - else - local binarydata = bytes(io.readfile(binarypath, {encoding = "binary"})) - local outputfile = io.open(outputpath, 'w') - if outputfile then - if not opt.nozeroend then - binarydata = binarydata .. bytes('\0') - end - _do_dump(binarydata, outputfile, opt) - outputfile:close() - end - end - - -- trace - cprint("${bright}%s generated!", outputpath) -end - -function main(...) - - -- parse arguments - local argv = {...} - local opt = option.parse(argv, options, "Print c/c++ code files from the given binary file." - , "" - , "Usage: xmake l private.utils.bin2c [options]") - - -- do bin2c - _do_bin2c(opt.binarypath, opt.outputpath, opt) -end diff --git a/xmake/modules/private/utils/bin2obj.lua b/xmake/modules/private/utils/bin2obj.lua deleted file mode 100644 index caa8b2e22..000000000 --- a/xmake/modules/private/utils/bin2obj.lua +++ /dev/null @@ -1,170 +0,0 @@ ---!A cross-platform build utility based on Lua --- --- Licensed 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-present, Xmake Open Source Community. --- --- @author ruki --- @file bin2obj.lua --- - --- imports -import("core.base.option") - -local options = { - {'i', "binarypath", "kv", nil, "Set the binary file path."}, - {'o', "outputpath", "kv", nil, "Set the output object file path."}, - {'f', "format", "kv", nil, "Set the object file format (coff, elf, macho)."}, - {nil, "symbol_prefix", "kv", nil, "Set the symbol prefix (default: _binary_)."}, - {'a', "arch", "kv", nil, "Set the target architecture."}, - {'p', "plat", "kv", nil, "Set the target platform (macosx, iphoneos, etc.)."}, - {nil, "target_minver", "kv", nil, "Set the target minimum version (e.g., 10.0, 18.2)."}, - {nil, "xcode_sdkver", "kv", nil, "Set the Xcode SDK version (e.g., 10.0, 18.2)."}, - {nil, "zeroend", "k", nil, "Append a null terminator ('\\0') at the end of data."} -} - -function _do_bin2obj_coff(binarypath, outputpath, opt) - -- get symbol prefix - local symbol_prefix = opt.symbol_prefix or "_binary_" - - -- get architecture (default: x86_64) - local arch = opt.arch or "x86_64" - - -- get zeroend (default: false) - local zeroend = opt.zeroend or false - - -- get filename from binary path (with extension, dots replaced with underscores) - local filename = path.filename(binarypath) - -- replace dots with underscores for symbol name (e.g., data.bin -> data_bin) - local basename = filename:gsub("%.", "_") - - -- trace - print("converting binary file %s to COFF object file %s ..", binarypath, outputpath) - - -- do dump - if utils.bin2coff then - utils.bin2coff(binarypath, outputpath, symbol_prefix, arch, basename, zeroend) - else - raise("bin2obj: utils.bin2coff not available (C implementation not compiled)") - end - - -- trace - cprint("${bright}%s generated!", outputpath) -end - -function _do_bin2obj_elf(binarypath, outputpath, opt) - -- get symbol prefix - local symbol_prefix = opt.symbol_prefix or "_binary_" - - -- get architecture (default: x86_64) - local arch = opt.arch or "x86_64" - - -- get zeroend (default: false) - local zeroend = opt.zeroend or false - - -- get filename from binary path (with extension, dots replaced with underscores) - local filename = path.filename(binarypath) - -- replace dots with underscores for symbol name (e.g., data.bin -> data_bin) - local basename = filename:gsub("%.", "_") - - -- trace - print("converting binary file %s to ELF object file %s ..", binarypath, outputpath) - - -- do dump - if utils.bin2elf then - utils.bin2elf(binarypath, outputpath, symbol_prefix, arch, basename, zeroend) - else - raise("bin2obj: utils.bin2elf not available (C implementation not compiled)") - end - - -- trace - cprint("${bright}%s generated!", outputpath) -end - -function _do_bin2obj_macho(binarypath, outputpath, opt) - -- get symbol prefix - local symbol_prefix = opt.symbol_prefix or "_binary_" - - -- get platform (default: macosx) - local plat = opt.plat or "macosx" - - -- get architecture (default: x86_64) - local arch = opt.arch or "x86_64" - - -- get target minimum version (default: nil, will use default 10.0.0 in C) - local target_minver = opt.target_minver - - -- get xcode sdk version (default: nil, will use default 10.0.0 in C) - local xcode_sdkver = opt.xcode_sdkver - - -- get zeroend (default: false) - local zeroend = opt.zeroend or false - - -- get filename from binary path (with extension, dots replaced with underscores) - local filename = path.filename(binarypath) - -- replace dots with underscores for symbol name (e.g., data.bin -> data_bin) - local basename = filename:gsub("%.", "_") - - -- trace - print("converting binary file %s to Mach-O object file %s ..", binarypath, outputpath) - - -- do dump - if utils.bin2macho then - utils.bin2macho(binarypath, outputpath, symbol_prefix, plat, arch, basename, target_minver, xcode_sdkver, zeroend) - else - raise("bin2obj: utils.bin2macho not available (C implementation not compiled)") - end - - -- trace - cprint("${bright}%s generated!", outputpath) -end - -function _do_bin2obj(binarypath, outputpath, opt) - - -- init source directory and options - opt = opt or {} - binarypath = path.absolute(binarypath) - outputpath = path.absolute(outputpath) - assert(os.isfile(binarypath), "%s not found!", binarypath) - - -- get format (default: coff) - local format = opt.format or "coff" - format = format:lower() - - -- validate format - if format ~= "coff" and format ~= "elf" and format ~= "macho" then - raise("bin2obj: unsupported format '%s' (supported: coff, elf, macho)", format) - end - - -- do conversion based on format - if format == "coff" then - _do_bin2obj_coff(binarypath, outputpath, opt) - elseif format == "elf" then - _do_bin2obj_elf(binarypath, outputpath, opt) - elseif format == "macho" then - _do_bin2obj_macho(binarypath, outputpath, opt) - end -end - -function main(...) - - -- parse arguments - local argv = {...} - local opt = option.parse(argv, options, "Convert binary file to object file for direct linking." - , "" - , "Usage: xmake l private.utils.bin2obj [options]") - - -- do bin2obj - _do_bin2obj(opt.binarypath, opt.outputpath, opt) -end - diff --git a/xmake/modules/utils/binary/bin2c.lua b/xmake/modules/utils/binary/bin2c.lua new file mode 100644 index 000000000..ce7336e36 --- /dev/null +++ b/xmake/modules/utils/binary/bin2c.lua @@ -0,0 +1,130 @@ +--!A cross-platform build utility based on Lua +-- +-- Licensed 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-present, Xmake Open Source Community. +-- +-- @author ruki +-- @file bin2c.lua +-- + +-- imports +import("core.base.bytes") +import("core.base.option") + +local options = { + {'w', "linewidth", "kv", nil, "Set the line width"}, + {nil, "nozeroend", "k", false, "Disable to patch zero terminating character"}, + {'i', "binarypath", "kv", nil, "Set the binary file path."}, + {'o', "outputpath", "kv", nil, "Set the output file path."} +} + +function _do_dump(binarydata, outputfile, opt) + local i = 0 + local n = 147 + local p = 0 + local e = binarydata:size() + local line = nil + local linewidth = opt.linewidth or 32 + local first = true + while p < e do + line = "" + if p + linewidth <= e then + for i = 0, linewidth - 1 do + if first then + first = false + line = line .. " " + else + line = line .. "," + end + line = line .. string.format(" 0x%02X", binarydata[p + i + 1]) + end + outputfile:print(line) + p = p + linewidth + elseif p < e then + local left = e - p + for i = 0, left - 1 do + if first then + first = false + line = line .. " " + else + line = line .. "," + end + line = line .. string.format(" 0x%02X", binarydata[p + i + 1]) + end + outputfile:print(line) + p = p + left + else + break + end + end +end + +function _do_bin2c(binarypath, outputpath, opt) + + -- init source directory and options + opt = opt or {} + binarypath = path.absolute(binarypath) + outputpath = path.absolute(outputpath) + assert(os.isfile(binarypath), "%s not found!", binarypath) + + -- trace + print("generating code data file from %s ..", binarypath) + + -- optimize the default linewidth for reading large file + if not opt.linewidth then + local filesize = os.filesize(binarypath) + if filesize > 1024 * 1024 * 1024 then + opt.linewidth = 512 + elseif filesize > 100 * 1024 * 1024 then + opt.linewidth = 256 + elseif filesize > 10 * 1024 * 1024 then + opt.linewidth = 128 + elseif filesize > 1024 * 1024 then + opt.linewidth = 64 + else + opt.linewidth = 32 + end + end + + -- do dump + if utils.bin2c then + utils.bin2c(binarypath, outputpath, opt) + else + local binarydata = bytes(io.readfile(binarypath, {encoding = "binary"})) + local outputfile = io.open(outputpath, 'w') + if outputfile then + if not opt.nozeroend then + binarydata = binarydata .. bytes('\0') + end + _do_dump(binarydata, outputfile, opt) + outputfile:close() + end + end + + -- trace + cprint("${bright}%s generated!", outputpath) +end + +function main(...) + + -- parse arguments + local argv = {...} + local opt = option.parse(argv, options, "Print c/c++ code files from the given binary file." + , "" + , "Usage: xmake l utils.binary.bin2c [options]") + + -- do bin2c + _do_bin2c(opt.binarypath, opt.outputpath, opt) +end + diff --git a/xmake/modules/utils/binary/bin2obj.lua b/xmake/modules/utils/binary/bin2obj.lua new file mode 100644 index 000000000..afb04dc3b --- /dev/null +++ b/xmake/modules/utils/binary/bin2obj.lua @@ -0,0 +1,170 @@ +--!A cross-platform build utility based on Lua +-- +-- Licensed 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-present, Xmake Open Source Community. +-- +-- @author ruki +-- @file bin2obj.lua +-- + +-- imports +import("core.base.option") + +local options = { + {'i', "binarypath", "kv", nil, "Set the binary file path."}, + {'o', "outputpath", "kv", nil, "Set the output object file path."}, + {'f', "format", "kv", nil, "Set the object file format (coff, elf, macho)."}, + {nil, "symbol_prefix", "kv", nil, "Set the symbol prefix (default: _binary_)."}, + {'a', "arch", "kv", nil, "Set the target architecture."}, + {'p', "plat", "kv", nil, "Set the target platform (macosx, iphoneos, etc.)."}, + {nil, "target_minver", "kv", nil, "Set the target minimum version (e.g., 10.0, 18.2)."}, + {nil, "xcode_sdkver", "kv", nil, "Set the Xcode SDK version (e.g., 10.0, 18.2)."}, + {nil, "zeroend", "k", nil, "Append a null terminator ('\\0') at the end of data."} +} + +function _do_bin2obj_coff(binarypath, outputpath, opt) + -- get symbol prefix + local symbol_prefix = opt.symbol_prefix or "_binary_" + + -- get architecture (default: x86_64) + local arch = opt.arch or "x86_64" + + -- get zeroend (default: false) + local zeroend = opt.zeroend or false + + -- get filename from binary path (with extension, dots replaced with underscores) + local filename = path.filename(binarypath) + -- replace dots with underscores for symbol name (e.g., data.bin -> data_bin) + local basename = filename:gsub("%.", "_") + + -- trace + print("converting binary file %s to COFF object file %s ..", binarypath, outputpath) + + -- do dump + if utils.bin2coff then + utils.bin2coff(binarypath, outputpath, symbol_prefix, arch, basename, zeroend) + else + raise("bin2obj: utils.bin2coff not available (C implementation not compiled)") + end + + -- trace + cprint("${bright}%s generated!", outputpath) +end + +function _do_bin2obj_elf(binarypath, outputpath, opt) + -- get symbol prefix + local symbol_prefix = opt.symbol_prefix or "_binary_" + + -- get architecture (default: x86_64) + local arch = opt.arch or "x86_64" + + -- get zeroend (default: false) + local zeroend = opt.zeroend or false + + -- get filename from binary path (with extension, dots replaced with underscores) + local filename = path.filename(binarypath) + -- replace dots with underscores for symbol name (e.g., data.bin -> data_bin) + local basename = filename:gsub("%.", "_") + + -- trace + print("converting binary file %s to ELF object file %s ..", binarypath, outputpath) + + -- do dump + if utils.bin2elf then + utils.bin2elf(binarypath, outputpath, symbol_prefix, arch, basename, zeroend) + else + raise("bin2obj: utils.bin2elf not available (C implementation not compiled)") + end + + -- trace + cprint("${bright}%s generated!", outputpath) +end + +function _do_bin2obj_macho(binarypath, outputpath, opt) + -- get symbol prefix + local symbol_prefix = opt.symbol_prefix or "_binary_" + + -- get platform (default: macosx) + local plat = opt.plat or "macosx" + + -- get architecture (default: x86_64) + local arch = opt.arch or "x86_64" + + -- get target minimum version (default: nil, will use default 10.0.0 in C) + local target_minver = opt.target_minver + + -- get xcode sdk version (default: nil, will use default 10.0.0 in C) + local xcode_sdkver = opt.xcode_sdkver + + -- get zeroend (default: false) + local zeroend = opt.zeroend or false + + -- get filename from binary path (with extension, dots replaced with underscores) + local filename = path.filename(binarypath) + -- replace dots with underscores for symbol name (e.g., data.bin -> data_bin) + local basename = filename:gsub("%.", "_") + + -- trace + print("converting binary file %s to Mach-O object file %s ..", binarypath, outputpath) + + -- do dump + if utils.bin2macho then + utils.bin2macho(binarypath, outputpath, symbol_prefix, plat, arch, basename, target_minver, xcode_sdkver, zeroend) + else + raise("bin2obj: utils.bin2macho not available (C implementation not compiled)") + end + + -- trace + cprint("${bright}%s generated!", outputpath) +end + +function _do_bin2obj(binarypath, outputpath, opt) + + -- init source directory and options + opt = opt or {} + binarypath = path.absolute(binarypath) + outputpath = path.absolute(outputpath) + assert(os.isfile(binarypath), "%s not found!", binarypath) + + -- get format (default: coff) + local format = opt.format or "coff" + format = format:lower() + + -- validate format + if format ~= "coff" and format ~= "elf" and format ~= "macho" then + raise("bin2obj: unsupported format '%s' (supported: coff, elf, macho)", format) + end + + -- do conversion based on format + if format == "coff" then + _do_bin2obj_coff(binarypath, outputpath, opt) + elseif format == "elf" then + _do_bin2obj_elf(binarypath, outputpath, opt) + elseif format == "macho" then + _do_bin2obj_macho(binarypath, outputpath, opt) + end +end + +function main(...) + + -- parse arguments + local argv = {...} + local opt = option.parse(argv, options, "Convert binary file to object file for direct linking." + , "" + , "Usage: xmake l utils.binary.bin2obj [options]") + + -- do bin2obj + _do_bin2obj(opt.binarypath, opt.outputpath, opt) +end + diff --git a/xmake/rules/utils/bin2c/xmake.lua b/xmake/rules/utils/bin2c/xmake.lua index fc05ecf4e..7be711af1 100644 --- a/xmake/rules/utils/bin2c/xmake.lua +++ b/xmake/rules/utils/bin2c/xmake.lua @@ -54,7 +54,7 @@ rule("utils.bin2c") if nozeroend then table.insert(argv, "--nozeroend") end - batchcmds:vlua("private.utils.bin2c", argv) + batchcmds:vlua("utils.binary.bin2c", argv) -- add deps batchcmds:add_depfiles(sourcefile_bin) diff --git a/xmake/rules/utils/bin2obj/xmake.lua b/xmake/rules/utils/bin2obj/xmake.lua index d35e50606..69fd9e717 100644 --- a/xmake/rules/utils/bin2obj/xmake.lua +++ b/xmake/rules/utils/bin2obj/xmake.lua @@ -89,7 +89,7 @@ rule("utils.bin2obj") if zeroend then table.insert(argv, "--zeroend") end - batchcmds:vlua("private.utils.bin2obj", argv) + batchcmds:vlua("utils.binary.bin2obj", argv) -- add deps batchcmds:add_depfiles(sourcefile_bin) diff --git a/xmake/rules/utils/glsl2spv/xmake.lua b/xmake/rules/utils/glsl2spv/xmake.lua index dfd1779fe..a6c4a2aef 100644 --- a/xmake/rules/utils/glsl2spv/xmake.lua +++ b/xmake/rules/utils/glsl2spv/xmake.lua @@ -86,7 +86,7 @@ rule("utils.glsl2spv") -- add commands local argv = {"--nozeroend", "-i", path(spvfilepath), "-o", path(headerfile)} - batchcmds:vlua("private.utils.bin2c", argv) + batchcmds:vlua("utils.binary.bin2c", argv) end -- add deps diff --git a/xmake/rules/utils/hlsl2spv/xmake.lua b/xmake/rules/utils/hlsl2spv/xmake.lua index 2b285d893..4af520420 100644 --- a/xmake/rules/utils/hlsl2spv/xmake.lua +++ b/xmake/rules/utils/hlsl2spv/xmake.lua @@ -86,7 +86,7 @@ rule("utils.hlsl2spv") -- add commands local argv = {"--nozeroend", "-i", path(spvfilepath), "-o", path(headerfile)} - batchcmds:vlua("private.utils.bin2c", argv) + batchcmds:vlua("utils.binary.bin2c", argv) end batchcmds:add_depfiles(sourcefile_hlsl) diff --git a/xmake/rules/xmake_cli/xmake.lua b/xmake/rules/xmake_cli/xmake.lua index d3a4b6f26..7c543cb36 100644 --- a/xmake/rules/xmake_cli/xmake.lua +++ b/xmake/rules/xmake_cli/xmake.lua @@ -55,7 +55,7 @@ rule("xmake.cli") local headerfile = path.join(headerdir, "luafiles.xmz.h") target:add("includedirs", headerdir) argv = {"--nozeroend", "-i", path(archivefile), "-o", path(headerfile)} - batchcmds:vlua("private.utils.bin2c", argv) + batchcmds:vlua("utils.binary.bin2c", argv) batchcmds:add_depfiles(sourcefiles) batchcmds:set_depmtime(os.mtime(dependfile)) -- cgit v1.3.1