Skip to content

Force FL window foreground when switching keyboard layout #3375

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 5 commits into from
Apr 4, 2025

Conversation

Jack251970
Copy link
Contributor

@Jack251970 Jack251970 commented Mar 24, 2025

Follow on with #3366.

When switching keyboard layout, we need to make sure foreground window is FL main window.

@Jack251970 Jack251970 added the Dev branch only An issue or fix for the Dev branch build label Mar 24, 2025
@Jack251970 Jack251970 added this to the 1.20.0 milestone Mar 24, 2025
@Jack251970 Jack251970 requested a review from Yusyuriv March 24, 2025 00:52
@Jack251970 Jack251970 enabled auto-merge March 24, 2025 00:52

This comment has been minimized.

Copy link

gitstream-cm bot commented Mar 24, 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/Win32Helper.cs

Activity based on git-commit:

Jack251970
APR 16 additions & 5 deletions
MAR 581 additions & 226 deletions
FEB 13 additions & 16 deletions
JAN 0 additions & 138 deletions
DEC 243 additions & 4 deletions
NOV

Knowledge based on git-blame:
Jack251970: 92%

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

Copy link

gitstream-cm bot commented Mar 24, 2025

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

Copy link
Contributor

coderabbitai bot commented Mar 24, 2025

Warning

Rate limit exceeded

@Jack251970 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 54 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between bc823b3 and f64ca66.

📒 Files selected for processing (1)
  • Flow.Launcher.Infrastructure/Win32Helper.cs (3 hunks)
📝 Walkthrough

Walkthrough

The changes update the Win32Helper class by adding two methods to check if a specified window or handle is the foreground window. The SwitchToEnglishKeyboardLayout method now retrieves the main window handle and verifies if it is in the foreground, setting it if necessary via a call to PInvoke.SetForegroundWindow. Additionally, a loop's variable name is updated in the language tag comparison for clarity and simplified logic.

Changes

File Change Summary
Flow.Launcher.Infrastructure/Win32Helper.cs • Added two methods: IsForegroundWindow(Window window) (public) and IsForegroundWindow(HWND handle) (internal).
• Modified SwitchToEnglishKeyboardLayout to obtain the main window handle via GetWindowHandle and include a foreground check with PInvoke.SetForegroundWindow, throwing a Win32Exception on failure.
• Renamed loop variable from langTag to imeLangTag and simplified the language tag comparison logic.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant Helper as Win32Helper
    participant PInvoke as PInvoke

    App->>Helper: Call SwitchToEnglishKeyboardLayout()
    Helper->>Helper: Retrieve main window handle via GetWindowHandle()
    Helper->>Helper: Check if handle is the foreground window (IsForegroundWindow)
    alt Window is not foreground
        Helper->>PInvoke: Invoke SetForegroundWindow(hwnd)
        PInvoke-->>Helper: Return status
        alt Operation fails
            Helper-->>App: Throw Win32Exception
        else Operation succeeds
            Helper-->>App: Continue execution
        end
    else Window is already foreground
        Helper-->>App: Continue execution
    end
Loading

Possibly related PRs

Suggested labels

bug, enhancement

Suggested reviewers

  • jjw24
  • taooceros
  • onesounds

Poem

In a burrow of code so deep,
I hopped and added methods to keep.
A window check to bring light,
Ensuring the foreground is set right.
With each line I dance with glee, 🐇
Celebrating the changes merrily!


🪧 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 plan to trigger planning for file edits and PR creation.
  • @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 Copilot March 27, 2025 10:52
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 pull request forces the FL main window to be the foreground window when switching keyboard layouts. Key changes include:

  • Added two overloaded methods to check if a window is the foreground window.
  • Modified SwitchToEnglishKeyboardLayout to obtain the FL main window handle and bring it to the foreground.
  • Renamed the loop variable in the IME language tag check for clarity.

This comment has been minimized.

@Jack251970 Jack251970 requested a review from Copilot March 27, 2025 11:43
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 ensures that when switching keyboard layouts, the FL main window is forced into the foreground.

  • Added two helper methods to check if a window or a handle is the foreground window.
  • Updated the keyboard layout switching logic to retrieve and force the FL main window to the foreground before proceeding.

@@ -124,6 +124,16 @@ public static bool SetForegroundWindow(nint handle)
return PInvoke.SetForegroundWindow(new(handle));
}

public static bool IsForegroundWindow(Window window)
{
return GetWindowHandle(window).Equals(PInvoke.GetForegroundWindow());
Copy link
Member

Choose a reason for hiding this comment

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

let call IsForegroundWindow with the handle from GetWindowHandle

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cannot get your idea. I already have a internal version which uses the handle from GetWindowHandle.

internal static bool IsForegroundWindow(HWND handle)
{
    return handle.Equals(PInvoke.GetForegroundWindow());
}

Copy link
Contributor Author

@Jack251970 Jack251970 Mar 30, 2025

Choose a reason for hiding this comment

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

Since HWND is an internal class, we cannot use that internal class in public function

Copy link
Member

Choose a reason for hiding this comment

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

huh? You can. Just do IsForegroundWindow(GetWindowHandle(window))

Copy link
Member

Choose a reason for hiding this comment

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

I think you misunderstand how the modifier works. It won't restrict which method it can call inside the body, but only whether other can call it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But it gives me error here:
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sorry for my misunderstanding, now I use GetWindowHandle inside its function

This comment has been minimized.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
Flow.Launcher.Infrastructure/Win32Helper.cs (1)

387-391: Consider optimizing the language tag check.

The loop calls GetLanguageTag(currentLangId) on each iteration, but currentLangId doesn't change within the loop. This is inefficient.

var currentLangId = (uint)currentLayout.Value & KeyboardLayoutLoWord;
+var currentLangTag = GetLanguageTag(currentLangId);
foreach (var imeLangTag in ImeLanguageTags)
{
-    var langTag = GetLanguageTag(currentLangId);
-    if (langTag.StartsWith(imeLangTag, StringComparison.OrdinalIgnoreCase)) return;
+    if (currentLangTag.StartsWith(imeLangTag, StringComparison.OrdinalIgnoreCase)) return;
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d66bdbb and db46a4a.

📒 Files selected for processing (1)
  • Flow.Launcher.Infrastructure/Win32Helper.cs (3 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
Flow.Launcher.Infrastructure/Win32Helper.cs (2)
Flow.Launcher.Infrastructure/PInvokeExtensions.cs (1)
  • PInvoke (8-25)
Flow.Launcher/MainWindow.xaml.cs (2)
  • MainWindow (30-1034)
  • MainWindow (70-82)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
🔇 Additional comments (3)
Flow.Launcher.Infrastructure/Win32Helper.cs (3)

127-130: The implementation looks good.

The method provides a useful public API for WPF applications to check if a Window is the foreground window, delegating to the internal implementation properly.


132-135: The implementation is correct.

This internal method provides the core implementation for checking if a window handle is the foreground window, which is exactly what was discussed in the previous review comments.


367-376: Foreground window check is now properly implemented.

Good implementation of getting the main window handle and ensuring it's the foreground window before proceeding with the keyboard layout switch. This addresses the main objective of the PR to force the FL window into foreground when switching keyboard layouts.

This comment has been minimized.

@Jack251970 Jack251970 requested a review from Copilot March 30, 2025 07:05
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 pull request ensures that the Flow Launcher (FL) main window is forced to the foreground when switching the keyboard layout.

  • Added new overloads for IsForegroundWindow to validate if a given Window or HWND is in the foreground.
  • Updated SwitchToEnglishKeyboardLayout to use the FL main window and to handle focus changes by calling SetForegroundWindow if needed.
  • Revised the IME language tag checking loop to streamline condition evaluation.

@Jack251970
Copy link
Contributor Author

@Yusyuriv Are we happy to merge this?

Copy link

github-actions bot commented Apr 4, 2025

@check-spelling-bot Report

🔴 Please review

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

❌ Errors Count
❌ forbidden-pattern 22
⚠️ non-alpha-in-dictionary 19

See ❌ Event descriptions for more information.

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 requested a review from onesounds April 4, 2025 09:26
@Jack251970 Jack251970 merged commit 4eba415 into Flow-Launcher:dev Apr 4, 2025
7 checks passed
@jjw24 jjw24 removed the 1 min review label Apr 5, 2025
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.

4 participants