Skip to content

Improve xmake.cli, use bin2obj#7416

Merged
waruqi merged 2 commits intodevfrom
cli
Mar 22, 2026
Merged

Improve xmake.cli, use bin2obj#7416
waruqi merged 2 commits intodevfrom
cli

Conversation

@waruqi
Copy link
Member

@waruqi waruqi commented Mar 22, 2026

  • Before adding new features and new modules, please go to issues to submit the relevant feature description first.
  • Write good commit messages and use the same coding conventions as the rest of the project.
  • Please commit code to dev branch and we will merge into master branch in feature
  • Ensure your edited codes with four spaces instead of TAB.

  • 增加新特性和新模块之前,请先到issues提交相关特性说明,经过讨论评估确认后,再进行相应的代码提交,避免做无用工作。
  • 编写友好可读的提交信息,并使用与工程代码相同的代码规范,代码请用4个空格字符代替tab缩进。
  • 请提交代码到dev分支,如果通过,我们会在特定时间合并到master分支上。
  • 为了规范化提交日志的格式,commit消息,不要用中文,请用英文描述。

@waruqi waruqi added this to the v3.0.8 milestone Mar 22, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the binary embedding mechanism for luafiles.xmz within the xmake.cli rule and its associated C/C++ templates. The change transitions from an include-based approach using a generated C header to a more streamlined method that directly embeds the binary data as an object file via the bin2obj utility. This improves the build process by reducing intermediate file generation and simplifying the integration of embedded resources.

Highlights

  • Binary Embedding Method Change: The method for embedding luafiles.xmz into executables has been switched from generating a C header file (luafiles.xmz.h) to directly embedding it as an object file using the bin2obj utility.
  • Source Code Updates: C and C++ source files that previously included the generated header and accessed data via a static array (g_luafiles_data) now declare _binary_luafiles_xmz_start and _binary_luafiles_xmz_end extern symbols, aligning with the bin2obj output.
  • Xmake Rule Simplification: The xmake.cli rule in xmake.lua has been simplified by removing the manual header directory creation, inclusion, and bin2c utility calls, replacing them with a single call to bin2obj_utils.generate_objectfile.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request replaces the bin2c utility with bin2obj for embedding Lua files in xmake.cli projects. This is a good improvement as it avoids generating large C header files and uses a more standard linker-based approach. The changes in the C/C++ templates and the xmake rule are mostly correct. However, I've found a potential regression where an empty set of Lua files could lead to a runtime assertion failure, which was previously prevented at compile time. I've suggested a fix to ensure the new implementation is as robust as the old one.

argv = {"--nozeroend", "-i", path(archivefile), "-o", path(headerfile)}
batchcmds:vlua("utils.binary.bin2c", argv)
-- convert archive to object file via bin2obj
bin2obj_utils.generate_objectfile(target, batchcmds, archivefile)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The xm_engine_add_embedfiles function, which is called by the C/C++ template code, contains an assertion that fails if the size of the embedded data is zero. The previous bin2c implementation would lead to a compile error if the generated header file was empty (from an empty luafiles.xmz), as static tb_byte_t const g_luafiles_data[] = {}; is invalid C. This effectively prevented the runtime assertion.

With the switch to bin2obj, it's possible to generate an object file from an empty archive where the _start and _end symbols are equal. This results in a size of 0, which will trigger the runtime assertion. This is a potential regression if a project has no Lua files to embed.

To ensure the embedded data is never empty, you can enable the zeroend option, which adds a null terminator. This guarantees a size of at least 1.

        bin2obj_utils.generate_objectfile(target, batchcmds, archivefile, {zeroend = true})

@waruqi waruqi merged commit 36b97ea into dev Mar 22, 2026
74 checks passed
@waruqi waruqi deleted the cli branch March 22, 2026 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant