Skip to content

Use PInvoke & Improve code comments & Use switch sentences #3652

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 1 commit into from
Jun 5, 2025

Conversation

Jack251970
Copy link
Member

Follow on with #3606 to provide code quality improvement.

@Jack251970 Jack251970 added the Dev branch only An issue or fix for the Dev branch build label Jun 5, 2025
Copy link

github-actions bot commented Jun 5, 2025

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors and Warnings Count
❌ forbidden-pattern 24
⚠️ non-alpha-in-dictionary 13

See ❌ Event descriptions for more information.

Forbidden patterns 🙅 (1)

In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.

These forbidden patterns matched content:

s.b. workaround(s)

\bwork[- ]arounds?\b
If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@Jack251970 Jack251970 added this to the 1.20.1 milestone Jun 5, 2025
@Jack251970 Jack251970 requested a review from Copilot June 5, 2025 08:19
Copy link

gitstream-cm bot commented Jun 5, 2025

🥷 Code experts: no user but you matched threshold 10

Jack251970 has most 👩‍💻 activity in the files.
Jack251970 has most 🧠 knowledge in the files.

See details

Flow.Launcher.Infrastructure/NativeMethods.txt

Activity based on git-commit:

Jack251970
JUN
MAY 9 additions & 2 deletions
APR 0 additions & 5 deletions
MAR 40 additions & 5 deletions
FEB 4 additions & 1 deletions
JAN 1 additions & 4 deletions

Knowledge based on git-blame:
Jack251970: 94%

Flow.Launcher.Infrastructure/Win32Helper.cs

Activity based on git-commit:

Jack251970
JUN
MAY 110 additions & 3 deletions
APR 202 additions & 33 deletions
MAR 581 additions & 226 deletions
FEB 13 additions & 16 deletions
JAN 0 additions & 138 deletions

Knowledge based on git-blame:
Jack251970: 95%

Flow.Launcher/MainWindow.xaml.cs

Activity based on git-commit:

Jack251970
JUN 1 additions & 1 deletions
MAY 140 additions & 43 deletions
APR 69 additions & 45 deletions
MAR 1141 additions & 1076 deletions
FEB 1 additions & 1 deletions
JAN

Knowledge based on git-blame:
Jack251970: 64%

To learn more about /:\ gitStream - Visit our Docs

Copy link

gitstream-cm bot commented Jun 5, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

@Jack251970 Jack251970 enabled auto-merge June 5, 2025 08:19
Copy link
Contributor

coderabbitai bot commented Jun 5, 2025

📝 Walkthrough

Walkthrough

This change introduces new Windows message and system command constants to the infrastructure layer and refactors window message handling in the main window logic. It adds explicit handling for non-client double-click and system command messages, reorganizes message dispatching, and updates drag-from-maximized behavior in the application's main window.

Changes

File(s) Change Summary
Flow.Launcher.Infrastructure/NativeMethods.txt,
Flow.Launcher.Infrastructure/Win32Helper.cs
Added constants for WM_NCLBUTTONDBLCLK, WM_SYSCOMMAND, SC_MAXIMIZE, and SC_MINIMIZE for Windows message handling.
Flow.Launcher/MainWindow.xaml.cs Refactored window message handling to use a switch statement, added handling for new messages, improved drag-from-maximized logic, and removed redundant constants.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MainWindow
    participant Win32Helper

    User->>MainWindow: MouseDown (on maximized window)
    MainWindow->>MainWindow: Restore to Normal state, reposition
    MainWindow->>MainWindow: Begin drag operation

    User->>MainWindow: Non-client area double-click
    MainWindow->>Win32Helper: Detect WM_NCLBUTTONDBLCLK
    MainWindow->>MainWindow: Block default maximize/minimize

    User->>MainWindow: Win+Up or Win+Down (system command)
    MainWindow->>Win32Helper: Detect WM_SYSCOMMAND, SC_MAXIMIZE/SC_MINIMIZE
    MainWindow->>MainWindow: Block maximize/minimize command
Loading

Possibly related PRs

Suggested labels

kind/ui

Suggested reviewers

  • jjw24
  • onesounds

Poem

A window hops, it will not shrink,
Nor maximize with just a wink.
With constants new and logic neat,
It stands its ground, won’t accept defeat.
Double-click, drag, or system call—
This launcher’s ready for it all!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9be5938 and 5fcb166.

📒 Files selected for processing (3)
  • Flow.Launcher.Infrastructure/NativeMethods.txt (1 hunks)
  • Flow.Launcher.Infrastructure/Win32Helper.cs (1 hunks)
  • Flow.Launcher/MainWindow.xaml.cs (3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
Flow.Launcher.Infrastructure/Win32Helper.cs (1)
Flow.Launcher.Infrastructure/PInvokeExtensions.cs (1)
  • PInvoke (7-45)
Flow.Launcher/MainWindow.xaml.cs (1)
Flow.Launcher.Infrastructure/Win32Helper.cs (1)
  • Win32Helper (28-794)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: gitStream workflow automation
  • GitHub Check: gitStream.cm
  • GitHub Check: build
🔇 Additional comments (4)
Flow.Launcher.Infrastructure/NativeMethods.txt (1)

45-49: LGTM! Standard Windows API constants added correctly.

The added constants (WM_NCLBUTTONDBLCLK, WM_SYSCOMMAND, SC_MAXIMIZE, SC_MINIMIZE) are standard Windows API identifiers for window message and system command handling. These align with the PR objective of using PInvoke and support the window message handling improvements in the main window.

Flow.Launcher.Infrastructure/Win32Helper.cs (1)

327-331: LGTM! Well-structured constant definitions following established patterns.

The new constants properly:

  • Follow the existing pattern of casting from PInvoke namespace values
  • Are placed in the appropriate WndProc region
  • Provide centralized access to Windows message and system command constants
  • Support the window message handling refactoring in MainWindow.xaml.cs

This approach centralizes these constants rather than having local definitions scattered throughout the codebase, which improves maintainability.

Flow.Launcher/MainWindow.xaml.cs (2)

468-517: LGTM! Thoughtful enhancement for drag-from-maximized behavior.

The implementation properly handles the complex scenario of dragging a window that was maximized via Windows Snap:

  • Calculates position ratios to maintain relative mouse position during state transition
  • Uses DispatcherPriority.ApplicationIdle to ensure window state changes complete before repositioning
  • Includes proper exception handling for InvalidOperationException during drag operations
  • Preserves the original drag behavior for non-maximized windows

The detailed comments explaining the behavior are also helpful for future maintenance.


541-614: LGTM! Excellent refactoring with improved message handling.

The WndProc method improvements include:

  • Switch statement conversion: Much more readable than the previous if-else chain, aligning with the PR objective of using switch expressions
  • New message blocking: Appropriately prevents unwanted window state changes:
    • WM_NCLBUTTONDBLCLK: Blocks title bar double-click maximize
    • WM_SYSCOMMAND: Blocks Win+Up/Win+Down keyboard shortcuts for maximize/minimize
  • Consistent handling: Both new cases properly set SizeToContent and mark messages as handled
  • Centralized constants: Uses Win32Helper constants instead of local definitions

The message blocking logic is appropriate for a launcher application that needs to maintain control over its window sizing behavior.

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@Jack251970 Jack251970 requested a review from onesounds June 5, 2025 08:20
@Jack251970
Copy link
Member Author

Could you please check if this has broken your fix? It works fine for me/

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refactors window message handling by centralizing Win32 constants via PInvoke, improves code comments around snapping behavior, and converts legacy if/else chains into switch statements.

  • Migrate local Win32 message/command constants to Win32Helper and NativeMethods.txt
  • Update OnMouseDown to use Application.Current.Dispatcher.Invoke and add explanatory comments
  • Refactor WndProc logic to a switch statement

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
Flow.Launcher/MainWindow.xaml.cs Updated drag handling comments, replaced BeginInvoke with sync Invoke, refactored WndProc to switch
Flow.Launcher.Infrastructure/Win32Helper.cs Added PInvoke-backed constants for window messages/commands
Flow.Launcher.Infrastructure/NativeMethods.txt Appended new message and command names for documentation
Comments suppressed due to low confidence (1)

Flow.Launcher/MainWindow.xaml.cs:492

  • Using a synchronous Dispatcher.Invoke on the UI thread may block rendering; consider using BeginInvoke or InvokeAsync to avoid potential UI jank.
Application.Current?.Dispatcher.Invoke(new Action(() =>

@onesounds
Copy link
Contributor

In my tests, there were no particular issues. It behaves the same as my PR.

@Jack251970 Jack251970 merged commit 3680440 into dev Jun 5, 2025
18 checks passed
@Jack251970 Jack251970 deleted the pinvoke_improvement branch June 5, 2025 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dev branch only An issue or fix for the Dev branch build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants