Skip to content

improve os.getenvs#6866

Merged
waruqi merged 5 commits into
devfrom
opti
Sep 28, 2025
Merged

improve os.getenvs#6866
waruqi merged 5 commits into
devfrom
opti

Conversation

@waruqi
Copy link
Copy Markdown
Member

@waruqi waruqi commented Sep 28, 2025

  • 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消息,不要用中文,请用英文描述。

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @waruqi, 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 os.getenvs functionality by moving the core logic for environment variable parsing and processing from Lua to C. This change aims to boost performance and enhance the reliability of environment variable handling, ensuring proper trimming and consistent capitalization, especially for Windows 'PATH' variables. As a result, the Lua-side code is streamlined, directly receiving a structured table of environment variables from the C implementation.

Highlights

  • Performance Improvement: The parsing and processing of environment variables have been migrated from Lua to C, which is expected to result in faster execution and improved efficiency.
  • Enhanced Robustness: Centralized logic for trimming whitespace from environment variable keys and values, along with consistent handling of Windows 'PATH' capitalization, is now managed at the C level, leading to more reliable behavior.
  • Simplified Lua API: The Lua-side os.getenvs function has been removed, as its functionality is now directly handled by the C implementation, which populates a Lua table with parsed key-value pairs, simplifying the Lua codebase.
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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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
Copy Markdown
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 refactors os.getenvs by moving the environment variable parsing logic from Lua to C, which should provide a nice performance boost. The C implementation is well-structured. My review includes a couple of suggestions to improve it further: one for const-correctness to enhance type safety and remove unsafe casts, and another to simplify pushing values to the Lua stack. The corresponding changes in the Lua code to remove the old implementation are correct.

Comment thread core/src/xmake/os/getenvs.c Outdated
Comment on lines +59 to +78
static tb_void_t xm_os_getenvs_trim(tb_char_t** sstr, tb_char_t** estr)
{
// check
tb_assert(sstr && estr && *sstr && *estr);

tb_char_t* p = *sstr;
tb_char_t* e = *estr;

// trim left
while (p < e && tb_isspace(*p))
p++;

// trim right
while (e > p && tb_isspace(*(e - 1)))
e--;

// save trimmed string
*sstr = p;
*estr = e;
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The xm_os_getenvs_trim function should be const-correct since it does not modify the content of the string, only the pointers to its start and end. Changing the signature to accept tb_char_t const** improves type safety and allows removing the unsafe casts in xm_os_getenvs_process_line at lines 99 and 103.

Suggested change
static tb_void_t xm_os_getenvs_trim(tb_char_t** sstr, tb_char_t** estr)
{
// check
tb_assert(sstr && estr && *sstr && *estr);
tb_char_t* p = *sstr;
tb_char_t* e = *estr;
// trim left
while (p < e && tb_isspace(*p))
p++;
// trim right
while (e > p && tb_isspace(*(e - 1)))
e--;
// save trimmed string
*sstr = p;
*estr = e;
}
static tb_void_t xm_os_getenvs_trim(tb_char_t const** sstr, tb_char_t const** estr)
{
// check
tb_assert(sstr && estr && *sstr && *estr);
tb_char_t const* p = *sstr;
tb_char_t const* e = *estr;
// trim left
while (p < e && tb_isspace(*p))
p++;
// trim right
while (e > p && tb_isspace(*(e - 1)))
e--;
// save trimmed string
*sstr = p;
*estr = e;
}

Comment thread core/src/xmake/os/getenvs.c Outdated
Comment on lines +124 to +127
if (value_len > 0)
lua_pushlstring(lua, value_start, value_len);
else
lua_pushliteral(lua, "");
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

This if/else block can be simplified. lua_pushlstring with a length of 0 correctly pushes an empty string, which is equivalent to lua_pushliteral(lua, ""). You can replace these four lines with a single call.

    lua_pushlstring(lua, value_start, value_len);

@waruqi waruqi added this to the v3.0.4 milestone Sep 28, 2025
@waruqi waruqi merged commit 75ab14b into dev Sep 28, 2025
44 checks passed
@waruqi waruqi deleted the opti branch September 28, 2025 08:01
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