fix: update comment handling in render-binja-import-script.py

[schecthellraiser606]

1. ret of get_comment_at is str

https://api.binary.ninja/binaryninja.function-module.html#binaryninja.function.Function.get_comment_at

2. set_comment is unkown in ver5.2

https://api.binary.ninja/binaryninja.function-module.html#binaryninja.function.Function.set_comment_at

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[gemini-code-assist]

Summary of Changes

Hello @schecthellraiser606, I'm Gemini Code Assist¹! 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 updates the render-binja-import-script.py script to ensure compatibility with recent changes in the Binary Ninja API. Specifically, it addresses modifications in how comments are retrieved and set, by removing redundant string encoding and updating a function name to match the current API specification.

Highlights

• API Compatibility: Removed unnecessary s.encode('ascii') calls in AppendComment and AppendLvarComment functions, as the get_comment_at function in Binary Ninja now returns a string directly, eliminating the need for explicit ASCII encoding.
• Function Renaming: Updated the fn.set_comment call to fn.set_comment_at within the AppendLvarComment function to align with the Binary Ninja API changes introduced in version 5.2, where the set_comment method was renamed.

🧠 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.

Changelog

• scripts/render-binja-import-script.py
  • Removed s.encode('ascii') from AppendComment function.
  • Removed s.encode('ascii') from AppendLvarComment function.
  • Changed fn.set_comment to fn.set_comment_at in AppendLvarComment function.

Activity

• No specific activity has been recorded for this pull request yet.

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. ↩

[gemini-code-assist]

Code Review

This pull request correctly addresses issues with comment handling in the generated Binary Ninja script. The changes ensure that strings are not incorrectly encoded and that the modern set_comment_at API function is used. While the changes in this PR are correct, I have identified two pre-existing critical bugs in the script generation logic that will cause the output script to fail at runtime. I've added specific comments on these issues. Addressing them is highly recommended to ensure the generated script is usable.

[gemini-code-assist]

Removing this encoding is correct as the Binary Ninja API expects strings. However, there is a critical pre-existing bug in this function. The line fn = fnc[0] (line 85) will raise an IndexError if bv.get_functions_containing(addr.address) returns an empty list. This can happen if a code reference points outside of any defined function. You should add a check to handle this case, for example:

fnc = bv.get_functions_containing(addr.address)
if not fnc:
    continue
fn = fnc[0]

[gemini-code-assist]

Changing set_comment to set_comment_at is correct for newer Binary Ninja versions. However, there's a critical issue in the surrounding code that will prevent this line from being reached. The loop for addr in [fva, pc]: on line 104 uses an undefined variable pc. This will cause a NameError when the generated script is executed. Given the comment that stack var comments are just added at the top of the function, it seems pc is a remnant and the loop should probably only iterate over [fva]. This pre-existing bug needs to be fixed for the function to work correctly.