Skip to content

Fixing callstack widget. #1909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 15, 2025

Conversation

nicolasnoble
Copy link
Member

No description provided.

Copy link
Contributor

coderabbitai bot commented Mar 19, 2025

Walkthrough

This pull request updates the draw method in the PCSX::Widgets::CallStacks class. A new integer variable callId is introduced to uniquely identify each call during rendering, and ImGui's Push/PopID functions are applied around button rendering to ensure unique identification. Additionally, label formatting for various call and stack values has been modified with unique suffixes to improve clarity in the GUI.

Changes

File Change Summary
src/gui/widgets/callstacks.cc Updated draw method: introduced a callId counter; added ImGui::PushID(callId++)/PopID() to wrap button rendering; modified label formatting for call.ra, call.sp, call.fp, stack.ra, and stack.fp with suffixes.

Sequence Diagram(s)

sequenceDiagram
    participant Widget as CallStacks Widget
    participant ImGui as ImGui Context
    Widget->>Widget: Initialize callId = 0
    loop For each call in stack
        Widget->>ImGui: PushID(callId++)
        Widget->>Widget: Format label with unique suffix (e.g., "##lowsp")
        Widget->>ImGui: Render button with formatted label
        Widget->>ImGui: PopID()
    end
Loading

Possibly related PRs

Poem

I'm a happy rabbit, hopping through code,
With unique IDs where once ambiguity strode.
New labels shine, each button stands apart,
Like carrots lined up, a true work of art.
In the garden of code, innovation's my ode! 🐇

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8cc3aa2 and 67fd798.

📒 Files selected for processing (1)
  • src/gui/widgets/callstacks.cc (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: pcsx-redux (x86_64-linux)
  • GitHub Check: pcsx-redux (aarch64-linux)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: toolchain
  • GitHub Check: macos-build-and-test-toolchain
  • GitHub Check: cross-arm64
  • GitHub Check: asan
  • GitHub Check: build
  • GitHub Check: build-openbios
  • GitHub Check: coverage
  • GitHub Check: aur-build
🔇 Additional comments (6)
src/gui/widgets/callstacks.cc (6)

68-68: Good improvement for ImGui identifier uniqueness.

Adding the callId counter provides the necessary context for the ImGui ID stack, ensuring each button in the callstack widget can be uniquely identified.


70-71: Well-structured ImGui ID scoping.

The use of PushID/PopID creates a proper scope for each call entry, ensuring that button identifiers within each call are unique even when addresses are identical. This pattern prevents potential ID collisions in the ImGui system.

Also applies to: 90-90


78-78: Consistent ID suffix for stack pointer button.

The added "##highsp" suffix helps uniquely identify this button in ImGui's internal state while maintaining the visible hex value for users. This is a good pattern consistent with other buttons.


85-85: Appropriate suffix for frame pointer button.

The added "##frame" suffix maintains consistency in how buttons are identified in the ImGui system while keeping the display clean for users.


93-93: Good distinction for heuristic return address.

The "##ralowsp" suffix effectively distinguishes this button from the regular call return addresses, preventing potential ID conflicts when addresses happen to be the same.


106-106: Consistent naming pattern for heuristic frame pointer.

The "##raframe" suffix follows the same pattern as other buttons, completing the consistent approach to ImGui button identification throughout the callstack display.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Apr 15, 2025

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 9.30%. Comparing base (34ea4f1) to head (d222c2d).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
src/gui/widgets/callstacks.cc 0.00% 8 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1909      +/-   ##
==========================================
- Coverage    9.30%    9.30%   -0.01%     
==========================================
  Files         469      469              
  Lines      145096   145099       +3     
==========================================
  Hits        13508    13508              
- Misses     131588   131591       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nicolasnoble nicolasnoble merged commit fddfff5 into grumpycoders:main Apr 15, 2025
22 of 23 checks passed
@nicolasnoble nicolasnoble deleted the callstacks-imgui-fix branch April 15, 2025 06: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